bridge-odata

OData JS SDK

Installation

 npm install restly/odata-js-sdk

Usage

  var bridge = require('odata-js-sdk')
  // Vendor defaults to `test`
  var bridge = new BridgeAPI(ACCESS_TOKEN, [vendor])

  // Fetches a list of Properties, provided by the vendor
  bridge
    .Properties()
    .exec()

API

new BridgeAPI(token, [vendor])

Returns a new instance of BridgeAPI. Requires an API token and optionally set the vendor (the MLS data source), defaults to test.

bridge.Property([ListingKey])

bridge.Member([MemberKey])

bridge.Office([OfficeKey])

bridge.OpenHouse([OpenHouseKey])

Returns a single entity if a key is specified. If a key is not specified all related entities are returned.

bridge.Media()

Returns all media.

bridge.count()

The number of results from the most recent query, set to 0 before and during query execution.

bridge.next()

Paginates to the next page of results.

bridge.prev()

Paginates to the previous page of results.

Example

A simple example of an autocomplete can be seen here, The SDK part of the code looks like:

  var BridgeAPI = require('./odata-js-sdk')

  const Bridge = new BridgeAPI(BridgeAPI.TEST_TOKEN)

  function autocomplete (address) {
    let prim = Bridge.Properties()
      .$select('','')
      .$filter({
        left: 'UnparsedAddress',
        comparator: 'startswith',
        right: address
      })
      .exec()

    return prim
  }

bridge.$filter(query)

Filtered queries can get complex however they are fairly powerful. One can write a JS object literal as the query that will map to a string query. e.g.

{right: 'a', op: 'eq', left: 'b'} => 'a eq b'
{right: 'a', op: 'intersect', left: 'b'} => 'geo.intersect(a,b)'

Hardcoded operations

The full list of operations can be found in the `src/lib/maps.js' file, but are not limited to:

Name	Operation	Description
eq	'a eq b'	checks if a == b
neq	'a neq b'	checks if a != b
lt	'a lt b'	checks if a < b
gt	'a gt b'	checks if a > b
ge	'a ge b'	checks if a >= b
le	'a le b'	checks if a <= b

Lambdas

The any and all operations are referred to and act as lambdas in the OData syntax.

Custom operations (unsafe)

In the event that one is aware of an operation that currently doesn't exist within the set of hardcoded operations they can create their own. With this syntax the object literal attributes must have the same name as the operation function parameters.

Example of a valid custom query

// Valid!
{
  right: 'Joe',
  left: '"The greatest person ever"',
  op: (right, left) => `${right} eq ${left}`
} => 'Joe eq "The greatest person ever"'

Example of an invalid custom query

// Invalid! Will throw error
{
  right: 'Joe',
  left: '"The greatest person ever"',
  op: (a,b) => `${a} eq ${b}`
} => ERROR