Prepare for release and update documentation and examples

Author: gpahal

README.md

@@ -133,25 +133,17 @@ try {
 provides two main ways to set data: JSON and RDF N-Quad. You can choose whichever
 way is convenient.
 
-We're going to use JSON. We define a person object to represent a person, serialize
-it as `Uint8Array` (or `base64`) and use it in `Mutation` object.
+We define a person object to represent a person and use it in a `Mutation` object.
 
 ```js
 // Create data.
 const p = {
     name: "Alice",
 };
 
-// Serialize it.
-const json = JSON.stringify(p);
-
-const serialized = new Uint8Array(new Buffer(json));
-// OR if you want to use base64
-// const serialized = new Buffer(json).toString("base64");
-
 // Run mutation.
 const mu = new dgraph.Mutation();
-mu.setSetJson(serialized);
+mu.setSetJson(p);
 await txn.mutate(mu);
 ```
 
@@ -174,10 +166,8 @@ GraphQL+- query string. If you want to pass an additional map of any variables t
 you might want to set in the query, call `Txn#queryWithVars(string, object)` with
 the variables object as the second argument.
 
-The response would contain `Response#getJSON_asU8()` and `Response#getJSON_asB64()`
-methods, which return the response JSON serialized as `Uint8Array` and `base64`
-respectively. You will need to deserialize it before you can do anything useful
-with it.
+The response would contain the method `Response#getJSON()`, which returns the response
+JSON.
 
 Let’s run the following query with a variable $a:
 
@@ -203,23 +193,17 @@ const query = `query all($a: string) {
 }`;
 const vars = { $a: "Alice" };
 const res = await dgraphClient.newTxn().queryWithVars(query, vars);
-
-// Deserialize result.
-const jsonStr = new Buffer(res.getJson_asU8()).toString();
-// OR if you want to use base64
-// const jsonStr = new Buffer(res.getJson_asB64(), "base64").toString();
-
-const ppl = JSON.parse(jsonStr);
+const ppl = res.getJson();
 
 // Print results.
-console.log(`people found: ${ppl.all.length}`);
+console.log(`Number of people named "Alice": ${ppl.all.length}`);
 ppl.all.forEach((person) => console.log(person.name));
 ```
 
 This should print:
 
 ```console
-people found: 1
+Number of people named "Alice": 1
 Alice
 ```
 

examples/simple/index-pre-v7.6.js

@@ -59,19 +59,12 @@ function createData(dgraphClient) {
         ]
     };
 
-    // Serialize it.
-    const json = JSON.stringify(p);
-
-    const serialized = new Uint8Array(new Buffer(json));
-    // OR if you want to use base64
-    // const serialized = new Buffer(json).toString("base64");
-
     let assigned;
     let err;
 
     // Run mutation.
     const mu = new dgraph.Mutation();
-    mu.setSetJson(serialized);
+    mu.setSetJson(p);
     return txn.mutate(mu).then((res) => {
         assigned = res;
 
@@ -121,12 +114,7 @@ function queryData(dgraphClient) {
     const vars = { $a: "Alice" };
 
     return dgraphClient.newTxn().queryWithVars(query, vars).then((res) => {
-        // Deserialize result.
-        const jsonStr = new Buffer(res.getJson_asU8()).toString();
-        // OR if you want to use base64
-        // const jsonStr = new Buffer(res.getJson_asB64(), "base64").toString();
-
-        const ppl = JSON.parse(jsonStr);
+        const ppl = res.getJson();
 
         // Print results.
         console.log(`Number of people named "Alice": ${ppl.all.length}`);

examples/simple/index.js

@@ -60,16 +60,9 @@ async function createData(dgraphClient) {
             ]
         };
 
-        // Serialize it.
-        const json = JSON.stringify(p);
-
-        const serialized = new Uint8Array(new Buffer(json));
-        // OR if you want to use base64
-        // const serialized = new Buffer(json).toString("base64");
-
         // Run mutation.
         const mu = new dgraph.Mutation();
-        mu.setSetJson(serialized);
+        mu.setSetJson(p);
         const assigned = await txn.mutate(mu);
 
         // Commit transaction.
@@ -113,13 +106,7 @@ async function queryData(dgraphClient) {
     }`;
     const vars = { $a: "Alice" };
     const res = await dgraphClient.newTxn().queryWithVars(query, vars);
-
-    // Deserialize result.
-    const jsonStr = new Buffer(res.getJson_asU8()).toString();
-    // OR if you want to use base64
-    // const jsonStr = new Buffer(res.getJson_asB64(), "base64").toString();
-
-    const ppl = JSON.parse(jsonStr);
+    const ppl = res.getJson();
 
     // Print results.
     console.log(`Number of people named "Alice": ${ppl.all.length}`);

examples/simple/package.json

@@ -1,7 +1,7 @@
 {
   "name": "simple",
   "dependencies": {
-    "dgraph-js": "^1.0.0",
+    "dgraph-js": "^1.0.1",
     "grpc": "^1.7.2"
   }
 }

lib/client.d.ts

@@ -1,17 +1,18 @@
 import * as messages from "../generated/api_pb";
 import { DgraphClientStub } from "./clientStub";
 import { Txn } from "./txn";
+import * as types from "./types";
 export declare class DgraphClient {
     private clients;
     private linRead;
     private debugMode;
     constructor(...clients: DgraphClientStub[]);
-    alter(op: messages.Operation): Promise<messages.Payload>;
+    alter(op: messages.Operation): Promise<types.Payload>;
     newTxn(): Txn;
     setDebugMode(mode?: boolean): void;
     debug(msg: string): void;
     getLinRead(): messages.LinRead;
     mergeLinReads(src?: messages.LinRead | null): void;
     anyClient(): DgraphClientStub;
 }
-export declare function deleteEdges(mu: messages.Mutation, uid: string, ...predicates: string[]): void;
+export declare function deleteEdges(mu: types.Mutation, uid: string, ...predicates: string[]): void;

lib/client.js

@@ -38,6 +38,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var messages = require("../generated/api_pb");
 var errors_1 = require("./errors");
 var txn_1 = require("./txn");
+var types = require("./types");
 var util_1 = require("./util");
 var DgraphClient = (function () {
     function DgraphClient() {
@@ -54,15 +55,16 @@ var DgraphClient = (function () {
     }
     DgraphClient.prototype.alter = function (op) {
         return __awaiter(this, void 0, void 0, function () {
-            var c, pl;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var c, pl, _a, _b;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
                     case 0:
                         this.debug("Alter request:\n" + util_1.stringifyMessage(op));
                         c = this.anyClient();
+                        _b = (_a = types).createPayload;
                         return [4, c.alter(op)];
                     case 1:
-                        pl = _a.sent();
+                        pl = _b.apply(_a, [_c.sent()]);
                         this.debug("Alter response:\n" + util_1.stringifyMessage(pl));
                         return [2, pl];
                 }

lib/clientStub.js

@@ -1,39 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = y[op[0] & 2 ? "return" : op[0] ? "throw" : "next"]) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [0, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 var grpc = require("grpc");
 var services = require("../generated/api_grpc_pb");
@@ -56,54 +21,19 @@ var DgraphClientStub = (function () {
         };
     }
     DgraphClientStub.prototype.alter = function (op) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4, this.promisified.alter(op)];
-                    case 1: return [2, _a.sent()];
-                }
-            });
-        });
+        return this.promisified.alter(op);
     };
     DgraphClientStub.prototype.query = function (req) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4, this.promisified.query(req)];
-                    case 1: return [2, _a.sent()];
-                }
-            });
-        });
+        return this.promisified.query(req);
     };
     DgraphClientStub.prototype.mutate = function (mu) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4, this.promisified.mutate(mu)];
-                    case 1: return [2, _a.sent()];
-                }
-            });
-        });
+        return this.promisified.mutate(mu);
     };
     DgraphClientStub.prototype.commitOrAbort = function (ctx) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4, this.promisified.commitOrAbort(ctx)];
-                    case 1: return [2, _a.sent()];
-                }
-            });
-        });
+        return this.promisified.commitOrAbort(ctx);
     };
     DgraphClientStub.prototype.checkVersion = function (check) {
-        return __awaiter(this, void 0, void 0, function () {
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4, this.promisified.checkVersion(check)];
-                    case 1: return [2, _a.sent()];
-                }
-            });
-        });
+        return this.promisified.checkVersion(check);
     };
     return DgraphClientStub;
 }());

lib/index.d.ts

@@ -1,4 +1,5 @@
-export * from "../generated/api_pb";
+export * from "./types";
+export { Operation, Request, Assigned, TxnContext, Check, Version, NQuad, Value, Facet, SchemaNode, LinRead, Latency } from "../generated/api_pb";
 export * from "./client";
 export * from "./clientStub";
 export * from "./errors";

lib/index.js

@@ -3,7 +3,20 @@ function __export(m) {
     for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
 }
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("../generated/api_pb"));
+__export(require("./types"));
+var api_pb_1 = require("../generated/api_pb");
+exports.Operation = api_pb_1.Operation;
+exports.Request = api_pb_1.Request;
+exports.Assigned = api_pb_1.Assigned;
+exports.TxnContext = api_pb_1.TxnContext;
+exports.Check = api_pb_1.Check;
+exports.Version = api_pb_1.Version;
+exports.NQuad = api_pb_1.NQuad;
+exports.Value = api_pb_1.Value;
+exports.Facet = api_pb_1.Facet;
+exports.SchemaNode = api_pb_1.SchemaNode;
+exports.LinRead = api_pb_1.LinRead;
+exports.Latency = api_pb_1.Latency;
 __export(require("./client"));
 __export(require("./clientStub"));
 __export(require("./errors"));

lib/txn.d.ts

@@ -1,16 +1,17 @@
 import * as messages from "../generated/api_pb";
 import { DgraphClient } from "./client";
+import * as types from "./types";
 export declare class Txn {
     private dc;
     private ctx;
     private finished;
     private mutated;
     constructor(dc: DgraphClient);
-    query(q: string): Promise<messages.Response>;
+    query(q: string): Promise<types.Response>;
     queryWithVars(q: string, vars?: {
         [k: string]: any;
-    } | null): Promise<messages.Response>;
-    mutate(mu: messages.Mutation): Promise<messages.Assigned>;
+    } | null): Promise<types.Response>;
+    mutate(mu: types.Mutation): Promise<messages.Assigned>;
     commit(): Promise<void>;
     discard(): Promise<void>;
     private mergeContext(src?);