@withonevision/omnihive-client v6.2.62

OmniHive Client

This is the main client for talking to the OmniHive Graph Server. Although the graph server can be used without this client, the methods and helpers contained here make communication with the client much simpler.

Use

This client works the best when in "singleton" mode or as a default export that is stored in the application since it maintains some state items when in use.

import OmniHiveClient from "@withonevision/omnihive-client/lib";
export default new OmniHiveClient();

GQL

All of the data methods of the OmniHive client are assuming the use of GQL for mutations and queries (See https://www.npmjs.com/package/graphql-tag). graph-tag has been imported throughout this library for you to use and it is the easiest way for you to construct queries for the OmniHive server. It is suggested you import this and GraphQL (See https://www.npmjs.com/package/graphql) into your projects.

Graph Client Type Enum

All queries and mutations work through an enum of GraphClientType. The graph client type consists of 6 possibilities:

• Database: Sets the graph endpoint as the data-driven endpoint of your particular dataGraphURL setting. This is what a large majority of your queries should use if you are only talking to a particular database.
• Custom: Sets the graph endpoint as the custom function endpoint of your particular dataGraphURL setting. This will contain any custom functions you have registered with your OmniHive Administrator.
• System: Sets the graph endpoint as the system endpoint of your particular dataGraphURL setting. This is used only in certain situtation to query server information from your OmniHive data cluster.
• HiveDatabase: Sets the graph endpoint as the data-driven endpoint of your particular hiveGraphURL setting. This is what will be used for any account-level queries.
• HiveCustom: Sets the graph endpoint as the custom function endpoint of your particular hiveGraphURL setting. This should only be used when instructed by your system administrator.
• HiveSystem: Sets the graph endpoint as the system endpoint of your particular hiveGraphURL setting. This should only be used when instructed by your system administrator.

Methods

init

Initializes the client and returns your OmniHive account

public init = async (
    accountName: string, accessClientId: string, accessClientSecret: string,
    dataGraphRootUrl: string, hiveGraphRootUrl?: string): Promise<Account>

runQuery

Runs any given query through the graph server and returns whatever structure the graph query returns exactly as it is given.

public runQuery = async (endpoint: GraphClientType, mutation: any): Promise<any>

runMutation

Runs any given mutation through the graph server and returns whatever structure the graph query returns exactly as it is given.

public runMutation = async (endpoint: GraphClientType, mutation: any): Promise<any>

runCustomSql

Takes any given SQL statement and runs it raw through the database engine underneath the graph server. Basic checking is done to make sure the query will not do things such as drop your database, etc. CAUTION: THIS METHOD WILL RUN WHATEVER YOU SEND IT SO ONLY USE IT IF YOU ARE AWARE OF WHAT SQL YOU ARE SENDING IN

This methods requires encryption keys and you will be required to set your private key with the encryption service first. The connection name will be the name of the database connection registered with the OmniHive Admin app.

public runCustomSql = async (myPublicKeyIdentifier: string, 
    connectionName: string, sql: string): Promise<any>

Services

Services are pre-made collections of methods and functions designed to help in the coding process and doing basic tasks quickly.

• Account Service : Methods dealing with your OmniHive Account
• Auth Service : Methods dealing with Cognito SSO (the preferred provider for OmniHive)
• Encryption Service : Methods dealing with both AES and RSA encryption. You must have your private key string array and public key identifier to work with the RSA methods.
• PubSub Service : This service integrates with Pusher (See https://www.pusher.com/channels) to provide integration with their "Channels" product. You can use these methods to send messages inter-app style...work with chat...event emitting...etc. Works off of a channel->event subscription model.
• System Service : All exposed graph methods detailing server information in your OmniHive cluster.
• Token Service : The methods you will need to get, verify, and use OAuth tokens in OmniHive. This is provided by AWS Cognito.
• WebStorage Service : Utilizes ZenDesk's cross-storage library (See https://www.npmjs.com/package/cross-storage) to provide cross-domain local storage. You may either set up your own hub for this or have your OmniHive administrator install a pre-configured hub for you using the OmniHive Server UI.