space-api v0.19.3

Client API for Space Cloud

Installation

Install via. npm

$ npm install space-api --save

or import as a stand alone library

<script src="https://spaceuptech.com/downloads/libraries/space-api.js"></script>

Documentation

The complete documentation can be found here.

Documentation for specific databases is given below:

• MongoDB
• SQL Databases

Documentation for real time feature is given below:

• Realtime Feature

Quick Start

Create Client Instance

import { API, and, or, cond } from 'space-api';

const api = new API('demo-project', 'http://localhost:4122');
const db = api.DB("mongo") // Put your database alias name here to create DB instance

Note: Multiple databases may be used simultaneously.

Insert a document into the database

const doc = {_id: 1, title: "Title 1", content: "My first record"};
db.insert('COLLECTION_NAME').doc(doc).apply().then(res => {
  if (res.status === 200) {
    // Document inserted successfully
    return;
  }
}).catch(ex => {
  // Exception occured while processing request
});

Note: Always insert documents with a id in order to use the realtime feature.

Query documents in database

const find = and(cond('title', '==', 'Title1'), cond('author', '==', 'Jon'));
db.get('COLLECTION_NAME').where(find)
  .skip(10).limit(10)
  .apply()
  .then(res => {
    if (res.status === 200) {
      // res.data contains the documents returned by the database
      console.log('Response:', res.data);
      return;
    }
  }).catch(ex => {
    // Exception occured while processing request
  });

Update documents in database

const find = and(cond('author', '==', 'Jon'));
db.update('COLLECTION_NAME').where(find)
  .set({ author: 'John' })
  .apply()
  .then(res => {
    if (res.status === 200) {
      // Document updated successfully
      return;
    }
  }).catch(ex => {
    // Exception occured while processing request
  });

Delete documents in database

const find = and(cond('author', '==', 'John'));
db.delete('COLLECTION_NAME').where(find)
  .apply()
  .then(res => {
    if (res.status === 200) {
      // Document deleted successfully
      return;
    }
  }).catch(ex => {
    // Exception occured while processing request
  });

Get real time updates

const onSnapshot  = (docs, type, find, changedDoc) => {
  if (type === 'initial') {
    console.log('Initial docs ', docs)
    return
  }
  console.log(docs, type, find, changedDoc)
}
 
const onError = (err) => {
  console.log('Monitor error', err)
}
 
let subscription = db.liveQuery('posts').where().subscribe(onSnapshot, onError) 
 
subscription.unsubscribe()

Upload file

const fileInput = document.querySelector('#your-file-input');
api.FileStore().uploadFile("/some-path", fileInput.files[0])
  .then(res => {
    if (res.status === 200) {
        console.log("File uploaded successfully");
    }
  }).catch(ex => {
    // Exception occured while uploading file
  })

Call functions directly (Function as a Service)

api.call('my-engine', 'my-func', { msg: 'Function as a Service is awesome!' }, 1000)
  .then(res => {
    if (res.status === 200) {
      console.log('Response: ', res.data)
    }
  }).catch(ex => {
    // Exception occured while processing request
  })

License

Copyright 2018 Noorain Panjwani

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.