Support for Embedded Tables #46

- improved .order()
- introduce .limit() and .offset() to allow setting limits and offset for foreign tables

Author: dragarcia

src/Builder.js

@@ -26,8 +26,8 @@ class Builder {
   }
 
   request(method) {
-    if(this.schema){
-      if(method == 'GET') this.headers['Accept-Profile'] = this.schema
+    if (this.schema) {
+      if (method == 'GET') this.headers['Accept-Profile'] = this.schema
       else this.headers['Content-Profile'] = this.schema
     }
     return new Request(method, this.url, this.headers)
@@ -57,7 +57,15 @@ class Builder {
           break
 
         case 'order':
-          request.order(queryFilter.property, queryFilter.ascending, queryFilter.nullsFirst)
+          request.order(queryFilter.columnName, queryFilter.ascending, queryFilter.nullsFirst)
+          break
+
+        case 'limit':
+          request.limit(queryFilter.columnName, queryFilter.criteria)
+          break
+
+        case 'offset':
+          request.offset(queryFilter.columnName, queryFilter.criteria)
           break
 
         case 'range':
@@ -105,17 +113,33 @@ class Builder {
     return this
   }
 
-  order(property, ascending = false, nullsFirst = false) {
+  order(columnName, ascending = false, nullsFirst = false) {
     this.queryFilters.push({
       filter: 'order',
-      property,
+      columnName,
       ascending,
       nullsFirst,
     })
 
     return this
   }
 
+  limit(columnName, criteria) {
+    this.queryFilters.push({
+      filter: 'limit',
+      columnName,
+      criteria
+    })
+  }
+
+  offset(columnName, criteria) {
+    this.queryFilters.push({
+      filter: 'offset',
+      columnName,
+      criteria
+    })
+  }
+
   range(from, to) {
     this.queryFilters.push({
       filter: 'range',

src/Request.js

@@ -12,6 +12,7 @@
 
 import { Request as SuperAgent } from 'superagent'
 import * as Filters from './utils/Filters'
+import * as Helpers from './utils/Helpers'
 
 const contentRangeStructure = /^(\d+)-(\d+)\/(\d+)$/
 
@@ -81,7 +82,6 @@ class Request extends SuperAgent {
 
     // for ranges, length of array should always be equal to 2
     if (['ovr', 'sl', 'sr', 'nxr', 'nxl', 'adj'].includes(operator) && criteria.length != 2) {
-
       return {
         body: null,
         status: 400,
@@ -145,19 +145,51 @@ class Request extends SuperAgent {
   /**
    * Tells PostgREST in what order the result should be returned.
    *
-   * @param {string} property The property name to order by.
+   * @param {string} columnName The columnName name to order by.
    * @param {bool} ascending True for descending results, false by default.
    * @param {bool} nullsFirst True for nulls first, false by default.
    * @returns {Request} The API request object.
    */
 
-  order(property, ascending = false, nullsFirst = false) {
+  order(columnName, ascending = false, nullsFirst = false) {
+    let { cleanedColumnName, foreignTableName } = Helpers.cleanColumnName(columnName)
+
     this.query(
-      `order=${property}.${ascending ? 'asc' : 'desc'}.${nullsFirst ? 'nullsfirst' : 'nullslast'}`
+      `${foreignTableName != null ? `${foreignTableName}.` : ''}order=${cleanedColumnName}.${
+        ascending ? 'asc' : 'desc'
+      }.${nullsFirst ? 'nullsfirst' : 'nullslast'}`
     )
     return this
   }
 
+  limit(criteria, columnName = null) {
+    if (typeof criteria != 'number') {
+      return {
+        body: null,
+        status: 400,
+        statusCode: 400,
+        statusText: `.limit() cannot be invoked with criteria that is not a number.`,
+      }
+    }
+
+    this.query(`${columnName != null ? `${columnName}.` : ''}limit=${criteria}`)
+    return this
+  }
+
+  offset(criteria, columnName = null) {
+    if (typeof criteria != 'number') {
+      return {
+        body: null,
+        status: 400,
+        statusCode: 400,
+        statusText: `.offset() cannot be invoked with criteria that is not a number.`,
+      }
+    }
+
+    this.query(`${columnName != null ? `${columnName}.` : ''}offset=${criteria}`)
+    return this
+  }
+
   /**
    * Specify a range of items for PostgREST to return. If the second value is
    * not defined, the rest of the collection will be sent back.

src/utils/Helpers.js

@@ -23,3 +23,14 @@ export function cleanFilterArray(filterArray) {
 
   return cleanedFilterArray
 }
+
+export function cleanColumnName(columnName) {
+  let cleanedColumnName = columnName
+  let foreignTableName = null
+  if (columnName.includes('.')) {
+    cleanedColumnName = columnName.split('.')[1]
+    foreignTableName = columnName.split('.')[0]
+  }
+
+  return { cleanedColumnName, foreignTableName }
+}