Merge pull request #73 from diegomvh/master

Count, Levels and allow Null values

Author: techniq

src/index.ts

@@ -4,8 +4,10 @@ const COLLECTION_OPERATORS = ['any', 'all'];
 const BOOLEAN_FUNCTIONS = ['startswith', 'endswith', 'contains'];
 const SUPPORTED_EXPAND_PROPERTIES = [
   'expand',
+  'levels',
   'select',
   'top',
+  'count',
   'orderby',
   'filter',
 ];
@@ -34,6 +36,8 @@ export type ExpandOptions<T> = {
   filter: Filter;
   orderBy: OrderBy<T>;
   top: number;
+  levels: number | 'max';
+  count: boolean | Filter;
   expand: Expand<T>;
 }
 
@@ -91,10 +95,10 @@ export const ITEM_ROOT = "";
 export default function <T>({
   select: $select,
   search: $search,
-  top: $top,
-  skip: $skip,
   skiptoken: $skiptoken,
   format: $format,
+  top,
+  skip,
   filter,
   transform,
   orderBy,
@@ -107,12 +111,7 @@ export default function <T>({
 }: Partial<QueryOptions<T>> = {}) {
   let path = '';
 
-  const params: any = {
-    $filter: (filter || count instanceof Object) && buildFilter(count instanceof Object ? count : filter),
-    $apply: transform && buildTransforms(transform),
-    $expand: expand && buildExpand(expand),
-    $orderby: orderBy && buildOrderBy(orderBy),
-  };
+  const params: any = {};
 
   if (key) {
     if (typeof key === 'object') {
@@ -125,6 +124,18 @@ export default function <T>({
     }
   }
 
+  if (filter || typeof count === 'object')
+    params.$filter = buildFilter(typeof count === 'object' ? count : filter);
+
+  if (transform)
+    params.$apply = buildTransforms(transform);
+
+  if (expand)
+    params.$expand = buildExpand(expand);
+
+  if (orderBy)
+    params.$orderby = buildOrderBy(orderBy);
+
   if (count) {
     if (typeof count === 'boolean') {
       params.$count = true;
@@ -133,6 +144,14 @@ export default function <T>({
     }
   }
 
+  if (typeof top === 'number') {
+    params.$top = top;
+  }
+
+  if (typeof skip === 'number') {
+    params.$skip = skip;
+  }
+
   if (action) {
     path += `/${action}`;
   }
@@ -159,7 +178,7 @@ export default function <T>({
       .reduce((acc, alias) => Object.assign(acc, {[alias.handleName()]: alias.handleValue()}), params);
   }
 
-  return buildUrl(path, { $select, $search, $top, $skip, $skiptoken, $format, ...params });
+  return buildUrl(path, { $select, $search, $skiptoken, $format, ...params });
 }
 
 function buildFilter(filters: Filter = {}, propPrefix = ''): string {
@@ -402,12 +421,22 @@ function buildExpand<T>(expands: Expand<T>): string {
     ) {
       return expandKeys
         .map(key => {
-          const value =
-            key === 'filter'
-              ? buildFilter((expands as NestedExpandOptions<any>)[key])
-              : key.toLowerCase() === 'orderby'
-                ? buildOrderBy((expands as NestedExpandOptions<any>)[key] as OrderBy<T>)
-                : buildExpand((expands as NestedExpandOptions<any>)[key] as Expand<T>);
+          let value;
+          switch (key) {
+            case 'filter':
+              value = buildFilter((expands as NestedExpandOptions<any>)[key]);
+              break;
+            case 'orderBy':
+              value = buildOrderBy((expands as NestedExpandOptions<any>)[key] as OrderBy<T>);
+              break;
+            case 'levels':
+            case 'count':
+            case 'top':
+              value = `${(expands as NestedExpandOptions<any>)[key]}`;
+              break;
+            default:
+              value = buildExpand((expands as NestedExpandOptions<any>)[key] as Expand<T>);
+          }
           return `$${key.toLowerCase()}=${value}`;
         })
         .join(';');
@@ -508,13 +537,9 @@ function buildOrderBy<T>(orderBy: OrderBy<T>, prefix: string = ''): string {
 
 function buildUrl(path: string, params: PlainObject): string {
   // This can be refactored using URL API. But IE does not support it.
-  const queries: string[] = [];
-  for (const key of Object.getOwnPropertyNames(params)) {
-    const value = params[key];
-    if (value === 0 || !!value) {
-      queries.push(`${key}=${value}`);
-    }
-  }
+  const queries: string[] = Object.getOwnPropertyNames(params)
+    .filter(key => params[key] !== undefined && params[key] !== '')
+    .map(key => `${key}=${params[key]}`);
   return queries.length ? `${path}?${queries.join('&')}` : path;
 }
 

test/index.test.ts

@@ -1464,6 +1464,29 @@ describe('expand', () => {
     expect(actual).toEqual(expected);
   });
 
+  it('should allow expand with count', () => {
+    const expand = { Friends: { count: true } };
+    const expected = '?$expand=Friends($count=true)';
+    const actual = buildQuery({ expand });
+    expect(actual).toEqual(expected);
+  });
+
+  it('should allow expand with levels', () => {
+    type Bar = { Friends: { Photos: any}, One: { Two: any }};
+    const expand: Expand<Bar> = { Friends: { expand: { Photos: { levels: 10 }}} };
+    const expected = '?$expand=Friends($expand=Photos($levels=10))';
+    const actual = buildQuery({ expand });
+    expect(actual).toEqual(expected);
+  });
+
+  it('should allow expand with max levels', () => {
+    type Bar = { Friends: { Photos: any}, One: { Two: any }};
+    const expand: Expand<Bar> = { Friends: { expand: { Photos: { levels: 'max' }}} };
+    const expected = '?$expand=Friends($expand=Photos($levels=max))';
+    const actual = buildQuery({ expand });
+    expect(actual).toEqual(expected);
+  });
+
   it('should allow expand with select and top', () => {
     const expand = { Friends: { select: 'Name', top: 10 } };
     const expected = '?$expand=Friends($select=Name;$top=10)';