fix example

Author: shivaji-kharse

README.md

@@ -80,7 +80,7 @@ Using the `open` function with a connection string:
 
 ```js
 // open a connection to an ACL-enabled, non-TLS cluster and login as groot
-const client = dgraph.open("dgraph://groot:password@localhost:8090")
+const client = await dgraph.open("dgraph://groot:password@localhost:8090")
 // Use the client
 
 // this will close all the client stubs
@@ -381,7 +381,7 @@ const SERVER_ADDR = "localhost:9080"
 const SERVER_CREDENTIALS = grpc.credentials.createInsecure()
 
 // Create instances of DgraphClient.
-const client = dgraph.open("dgraph://groot:password@${SERVER_ADDR}")
+const client = await dgraph.open("dgraph://groot:password@${SERVER_ADDR}")
 
 // ...
 // Use dgraphClient

examples/simple/index.js

@@ -115,7 +115,7 @@ async function queryData(dgraphClient) {
 }
 
 async function main() {
-  const dgraphClient = dgraph.open()
+  const dgraphClient = await dgraph.open("dgraph://groot:password@localhost:8090")
   await dropAll(dgraphClient)
   await setSchema(dgraphClient)
   await createData(dgraphClient)

lib/client.d.ts

@@ -21,6 +21,8 @@ export declare class DgraphClient {
   setDebugMode(mode?: boolean): void
   debug(msg: string): void
   anyClient(): DgraphClientStub
+  close(): void
 }
 export declare function isJwtExpired(err: any): boolean
 export declare function deleteEdges(mu: types.Mutation, uid: string, ...predicates: string[]): void
+export declare function open(connStr: string): Promise<DgraphClient>

lib/client.js

@@ -141,11 +141,18 @@ Object.defineProperty(exports, "__esModule", { value: true })
 exports.DgraphClient = void 0
 exports.isJwtExpired = isJwtExpired
 exports.deleteEdges = deleteEdges
+exports.open = open
+var grpc = require("@grpc/grpc-js")
 var messages = require("../generated/api_pb")
+var clientStub_1 = require("./clientStub")
 var errors_1 = require("./errors")
 var txn_1 = require("./txn")
 var types = require("./types")
 var util_1 = require("./util")
+var dgraphScheme = "dgraph:"
+var sslModeDisable = "disable"
+var sslModeRequire = "require"
+var sslModeVerifyCA = "verify-ca"
 var DgraphClient = (function () {
   function DgraphClient() {
     var clients = []
@@ -220,6 +227,16 @@ var DgraphClient = (function () {
   DgraphClient.prototype.anyClient = function () {
     return this.clients[Math.floor(Math.random() * this.clients.length)]
   }
+  DgraphClient.prototype.close = function () {
+    this.clients.forEach(function (clientStub) {
+      try {
+        clientStub.close()
+        console.log("Closed client stub successfully")
+      } catch (error) {
+        console.error("Failed to close client stub:", error)
+      }
+    })
+  }
   return DgraphClient
 })()
 exports.DgraphClient = DgraphClient
@@ -245,3 +262,99 @@ function deleteEdges(mu, uid) {
     mu.addDel(nquad)
   }
 }
+function addApiKeyToCredentials(baseCreds, apiKey) {
+  var metaCreds = grpc.credentials.createFromMetadataGenerator(function (_, callback) {
+    var metadata = new grpc.Metadata()
+    metadata.add("authorization", apiKey)
+    callback(null, metadata)
+  })
+  return grpc.credentials.combineChannelCredentials(baseCreds, metaCreds)
+}
+function addBearerTokenToCredentials(baseCreds, bearerToken) {
+  var metaCreds = grpc.credentials.createFromMetadataGenerator(function (_, callback) {
+    var metadata = new grpc.Metadata()
+    metadata.add("Authorization", "Bearer ".concat(bearerToken))
+    callback(null, metadata)
+  })
+  return grpc.credentials.combineChannelCredentials(baseCreds, metaCreds)
+}
+function open(connStr) {
+  return __awaiter(this, void 0, void 0, function () {
+    var parsedUrl, host, port, queryParams, sslMode, credentials, clientStub, err_1
+    return __generator(this, function (_a) {
+      switch (_a.label) {
+        case 0:
+          parsedUrl = new URL(connStr)
+          if (parsedUrl.protocol !== dgraphScheme) {
+            throw new Error("Invalid scheme: must start with dgraph://")
+          }
+          host = parsedUrl.hostname
+          port = parsedUrl.port
+          if (!host) {
+            throw new Error("Invalid connection string: hostname required")
+          }
+          if (!port) {
+            throw new Error("Invalid connection string: port required")
+          }
+          queryParams = {}
+          if (parsedUrl.searchParams) {
+            parsedUrl.searchParams.forEach(function (value, key) {
+              queryParams[key] = value
+            })
+          }
+          if (queryParams.apikey && queryParams.bearertoken) {
+            throw new Error("Both apikey and bearertoken cannot be provided")
+          }
+          sslMode = queryParams.sslmode
+          if (sslMode === undefined) {
+            sslMode = sslModeDisable
+          }
+          switch (sslMode) {
+            case sslModeDisable:
+              credentials = grpc.credentials.createInsecure()
+              break
+            case sslModeRequire:
+              credentials = grpc.credentials.createSsl(null, null, null, {
+                checkServerIdentity: function () {
+                  return undefined
+                },
+              })
+              break
+            case sslModeVerifyCA:
+              credentials = grpc.credentials.createSsl()
+              break
+            default:
+              throw new Error(
+                "Invalid SSL mode: ".concat(
+                  sslMode,
+                  " (must be one of disable, require, verify-ca)",
+                ),
+              )
+          }
+          if (queryParams.apikey) {
+            credentials = addApiKeyToCredentials(credentials, queryParams.apikey)
+          } else if (queryParams.bearertoken) {
+            credentials = addBearerTokenToCredentials(credentials, queryParams.bearertoken)
+          }
+          clientStub = new clientStub_1.DgraphClientStub(
+            "".concat(host, ":").concat(port),
+            credentials,
+          )
+          if (!(parsedUrl.username != "")) return [3, 4]
+          if (!(parsedUrl.password === "")) return [3, 1]
+          throw new Error("Invalid connection string: password required when username is provided")
+        case 1:
+          _a.trys.push([1, 3, , 4])
+          return [4, clientStub.login(parsedUrl.username, parsedUrl.password)]
+        case 2:
+          _a.sent()
+          return [3, 4]
+        case 3:
+          err_1 = _a.sent()
+          throw new Error("Failed to sign in user: ".concat(err_1.message))
+        case 4:
+          return [2, new DgraphClient(clientStub)]
+      }
+    })
+  })
+}

lib/types.d.ts

@@ -5,25 +5,25 @@
 
 import * as messages from "../generated/api_pb"
 export declare class Payload extends messages.Payload {
-  getData(): string | Uint8Array
+  getData(): any
   getData_asB64(): string
   getData_asU8(): Uint8Array
   setData(value: any): void
 }
 export declare function createPayload(oldPayload: messages.Payload): Payload
 export declare class Response extends messages.Response {
-  getJson(): string | Uint8Array
+  getJson(): any
   getJson_asB64(): string
   getJson_asU8(): Uint8Array
   setJson(value: any): void
 }
 export declare function createResponse(oldResponse: messages.Response): Response
 export declare class Mutation extends messages.Mutation {
-  getSetJson(): string | Uint8Array
+  getSetJson(): any
   getSetJson_asB64(): string
   getSetJson_asU8(): Uint8Array
   setSetJson(value: any): void
-  getDeleteJson(): string | Uint8Array
+  getDeleteJson(): any
   getDeleteJson_asB64(): string
   getDeleteJson_asU8(): Uint8Array
   setDeleteJson(value: any): void

package.json

@@ -1,7 +1,6 @@
 {
   "name": "dgraph-js",
   "version": "24.1.0",
-  "type": "module",
   "description": "Official javascript client for Dgraph",
   "license": "Apache-2.0",
   "repository": {