Subscriptions are added with tests

README.md

@@ -113,6 +113,35 @@ result = {
     }
 } 
 */
+
+
+//subscription
+let unsub = om.subscribe({
+    user: {
+        where: {
+            is_live: {
+                _eq: true
+            }
+        },
+        limit: 10,
+        order_by: {
+            rating: 'desc'
+        }
+    },
+    pets: {
+        where: {
+            type: {
+                _eq: 'dog'
+            }
+        },
+        fields: `
+            id
+            name
+        `
+    }
+}, ([err, data]) => {
+    //so data will come in the same format as the query
+})
 ```
 
 The only control you have is fragments. So this library provides base fragments with all table fields without relations. Of course you need them, so you have many ways to do so.

package.json

@@ -27,7 +27,9 @@
     }
   },
   "dependencies": {
-    "axios": "^0.19.2"
+    "axios": "^0.19.2",
+    "subscriptions-transport-ws": "^0.9.16",
+    "ws": "^7.3.0"
   },
   "devDependencies": {
     "ava": "^3.8.2",

src/hasura/wsgql.js

@@ -0,0 +1,72 @@
+const __ = require('../utils/helpers');
+const ws = require('ws');
+const { SubscriptionClient } = require('subscriptions-transport-ws');
+
+class WsGql {
+	constructor(params) {
+		const defaultParams = {
+			wsUrl: null,
+			adminSecret: null,
+			reconnect: true,
+			lazy: true,
+		};
+		this.params = Object.assign({}, defaultParams, params);
+
+		this.client = new SubscriptionClient(
+			this.params.wsUrl,
+			{
+				reconnect: this.params.reconnect,
+				lazy: this.params.lazy,
+				connectionParams: {
+					headers: {
+						'X-Hasura-Role': 'admin',
+						'x-hasura-admin-secret': this.params.adminSecret,
+					},
+				},
+			},
+			ws,
+		);
+
+		/* this.client.on('connected', (data) => {
+            console.log('client connected', data)
+        })
+        this.client.on('reconnected', (data) => {
+            console.log('client reconnected', data)
+        })
+        this.client.on('connecting', (data) => {
+            console.log('client connecting', data)
+        })
+        this.client.on('reconnecting', (data) => {
+            console.log('client reconnecting', data)
+        })
+        this.client.on('disconnected', (data) => {
+            console.log('client disconnected', data)
+        })
+        this.client.on('error', (data) => {
+            console.log('client error', data.message)
+        }) */
+	}
+
+	async run({ query, variables, callback, settings } = {}) {
+		let { subscribe } = this.client.request({
+			query,
+			variables,
+		});
+
+		let { unsubscribe } = subscribe({
+			next(data) {
+				callback([null, settings.flatOne ? data.data[settings.flatOne] : data.data]);
+			},
+			error(err) {
+				callback([err]);
+			},
+			complete() {
+				//console.log('SUB COMPLETED')
+			},
+		});
+
+		return unsubscribe;
+	}
+}
+
+module.exports = WsGql;

src/orm/hasura.js

@@ -1,5 +1,6 @@
 const Sql = require('../hasura/sql');
 const Gql = require('../hasura/gql');
+const WsGql = require('../hasura/wsgql');
 const Table = require('./table');
 const __ = require('../utils/helpers');
 
@@ -8,6 +9,7 @@ class Hasura {
 		const defaultParams = {
 			graphqlUrl: null,
 			queryUrl: null,
+			wsUrl: null,
 			adminSecret: null,
 		};
 		this.params = Object.assign({}, defaultParams, params);
@@ -18,9 +20,11 @@ class Hasura {
 		if (!this.params.adminSecret) throw new Error('adminSecret is required');
 
 		if (!this.params.queryUrl) this.params.queryUrl = this.params.graphqlUrl.replace('/v1/graphql', '/v1/query');
+		if (!this.params.wsUrl) this.params.wsUrl = this.params.graphqlUrl.replace('http://', 'ws://').replace('https://', 'wss://');
 
 		this.$sql = new Sql(this.params);
 		this.$gql = new Gql(this.params);
+		this.$ws = new WsGql(this.params);
 
 		this.INITIATED = false;
 		this.tables = {};
@@ -132,7 +136,7 @@ class Hasura {
 		return [null, response];
 	}
 
-	buildQuery(params) {
+	buildQuery(params, queryType = 'query') {
 		let tables = Object.keys(params);
 
 		let queryName = [],
@@ -143,9 +147,10 @@ class Hasura {
 
 		let builds = [];
 		tables.forEach((tableName) => {
-			let built = this.tables[tableName].buildQuery({
+			let built = this.table(tableName).buildQuery({
 				...params[tableName],
 				tableName,
+				queryType,
 			});
 
 			queryName.push(built.query.name);
@@ -157,7 +162,7 @@ class Hasura {
 
 		let query = `
             ${Object.values(queryFragments).join('\n')}
-            query ${queryName.join('_')} ${queryVariables.length ? '(' + queryVariables.join(', ') + ')' : ''} {
+            ${queryType} ${queryName.join('_')} ${queryVariables.length ? '(' + queryVariables.join(', ') + ')' : ''} {
                 ${queryFields.join('\n')}
             }
         `;
@@ -259,6 +264,25 @@ class Hasura {
 
 		return [query, variables, queryFlatSetting];
 	}
+
+	subscribe(params, callback, { flatOne = true } = {}) {
+		try {
+			var [query, variables] = this.buildQuery(params, 'subscription');
+		} catch (err) {
+			return [err];
+		}
+
+		var unsub = this.$ws.run({
+			query,
+			variables,
+			callback,
+			settings: {
+				flatOne: Object.keys(params).length == 1 && flatOne ? Object.keys(params)[0] : false,
+			},
+		});
+
+		return unsub; //unsubscribe
+	}
 }
 
 module.exports = Hasura;

src/orm/table.js

@@ -121,9 +121,11 @@ class Table {
 			}
 		});
 
+		//building for query or subscription
+		let queryLiteral = params.queryType == 'query' ? 'Q' : 'S';
 		return {
 			query: {
-				name: `Q${this.params.name}`,
+				name: `${queryLiteral}_${this.params.name}`,
 				variables: query_variables,
 				fields: `
                     ${this.params.name} ${query_field_variables.length ? '(' + query_field_variables.join(', ') + ')' : ''} {