What is

CHROMA is a real-time user & data platform that enables new ways of working with data.

The platform is not publicly available yet. We are currently building the Microdose VR network on it, but have built it to allow other projects to integrate in the future.

Getting Started

This library is only useful if you are developing on the CHROMA Platform.

Installation

Install via NPM

npm install @chromaplatform/chromajs

Basic Usage

You can use chroma.js to make queries against the platform data.

// Import chromajs into your project
import chroma from '@chromaplatform/chromajs'

// Set token in chromajs 
//   This is generally done after a successful authentication or on load 
//   if user is already authenticated)
chroma.setToken(token)

// Make queries
const query = {
    "service": "users",
    "query": {"username":"sporeganic"}
    "fields": "meta{profile{bio}}"
}
const result = await chromajs.find(query)

chromaQL

chromaQL is a query language developed to enable a wide range of data requests on the platform.

Requests are described by an object containing the details of your query.

There are three types of chromaQL queries, chroma.find(), chroma.get() and chroma.set().

chroma.find(request)

https://api.chroma.vision/query/find

{
    "service": "users",
    "query": {"username":"sporeganic"}
    "fields": "meta{profile{bio}}"
}

chroma.get(request)

https://api.chroma.vision/query/get

{
    "service": "users",
    "id": "5fe0f6702033242be27187ef",
    "fields": "meta{profile{bio}}"
}

chroma.set(request)

https://api.chroma.vision/query/set

/* This change the users email address */
{
  "id": "5fe0f6702033242be27187ef",
  "path": "users/email",
  "value": "[email protected]"
}

Overwrite Parameter

This will cause the key at the path's location to be overwritten with the value, regardless of if it is an object in the database.

In the following example, we would be setting the entire user.meta.profile object to the new incoming object. Usually, you do not want to overwrite entire objects, so pay close attention when using this.

/* BE CAREFUL WITH THIS */
{
  "id": "5fe0f6702033242be27187ef",
  "path": "users/meta/profile",
  "overwrite": true
  "value": {...newProfile}
}

Operator Parameter

You can change the functionality of the set method by passing an optional operator parameter.

• "increment"

(untested/in dev)

• "addKey"
• "pushToArray"
• "setArrayIndex"
• "removeArrayIndex"
• "addWhere"
• "removeWhere"
• "append"

/* This will add one minute to the users minutesPlayed */
{
  "id": "5fe0f6702033242be27187ef",
  "path": "users/meta/appData/MDVR/sessions/minutesPlayed",
  "operator": "increment",
  "value": 1
}

Contact

[email protected]