@tdxvolt/volt-client-grpc 0.20.10 → 0.20.11

package/lib/index.cjs

@@ -10,12 +10,12 @@ var debug = require('debug');
 var Protobuf = require('protobufjs');
 var camelCase = require('lodash.camelcase');
 var descriptor = require('protobufjs/ext/descriptor/index.js');
+var voltUtility = require('@tdxvolt/volt-utility');
 var EventEmitter = require('events');
 var fs = require('fs');
 var path = require('path');
 var jwt = require('jsonwebtoken');
 var crypto = require('crypto');
-var voltUtility = require('@tdxvolt/volt-utility');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1266,128 +1266,6 @@ message RemoteResponse {
     HttpRequest http_request = 5;
   }
 }
-`;
-const spark_api = `syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-
-// The Spark API allows clients to start and communicate with Spark VMs.
-service SparkAPI {
-  // Start or connect to a spark VM and establish a long-lived communication channel.
-  rpc Spark(stream SparkRequest) returns (stream SparkResponse);
-
-  // Get details of running spark VMs.
-  rpc GetSpark(GetSparkRequest) returns (GetSparkResponse);
-}
-
-// Start a resource-hosted spark.
-// Provenance is determined from the resource owner.
-message StartSparkResource {
-  // The id of the resource containing the VM byte code.
-  string resource_id = 1;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 2;
-
-  // Envelope signature.
-  string signature = 3;
-}
-
-// Start a spark from byte code included in the payload, along with issuer/developer claims and signature.
-message StartSparkAdhoc {
-  // Ad-hoc byte code of VM to run.
-  bytes byte_code = 1;
-
-  // Verifiable credentials associated with this spark.
-  repeated string credential = 2;
-
-  // Envelope signature.
-  string signature = 3;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 4;
-}
-
-// Send commands and payloads to communicate with a running spark.
-message SparkCommand {
-  // Optional id to associate with this command.
-  // If this is omitted, an id will be assigned and returned in the command acknowledgement.
-  string command_id = 1;
-
-  // The command to send to the spark.
-  string command = 2;
-
-  // The command payload.
-  string payload = 3;
-
-  // Command verifiable credential.
-  string credential = 4;
-
-  // Command signature.
-  string signature = 5;
-}
-
-// The request must contain one of the messages indicated below.
-message SparkRequest {
-  oneof payload {
-    StartSparkResource start_resource = 1;
-    StartSparkAdhoc start_adhoc = 2;
-    SparkCommand command = 3;
-  }
-}
-
-// Receive events and payload from a running spark.
-message SparkData {
-  // The command id to which this data corresponds.
-  string command_id = 1;
-
-  oneof payload {
-    // Acknowledges receipt of a spark command.
-    bool acknowledge = 2;
-
-    // Indicates the command has completed.
-    bool ended = 3;
-
-    // Will contain error details on command failure.
-    string error = 4;
-
-    // Data emitted by a command, usually in stringified JSON format.
-    string data = 5;
-  }
-}
-
-// Details of a spark instance.
-message SparkInstance {
-  // The UUID assigned to the spark instance.
-  string spark_id = 1;
-}
-
-// The response will contain one of the messages indicated below.
-message SparkResponse {
-  oneof payload {
-    // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status status = 1;
-
-    // Details of the spark instance, sent in response to a start command.
-    SparkInstance spark_instance = 2;
-
-    // Payload data emitted by the spark.
-    SparkData spark_data = 3;
-  }
-}
-
-message GetSparkRequest {
-  string spark_id = 1;
-}
-
-// One of the following fields will be present in the response.
-message GetSparkResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
 `;
 const ssi = `syntax = "proto3";
 
@@ -1463,12 +1341,11 @@ const ssi_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
 
-import "tdx/volt_api/volt/v1/status.proto";
 import "tdx/volt_api/volt/v1/ssi.proto";
+import "tdx/volt_api/volt/v1/status.proto";
 
 service SsiAPI {
-  // Get a short-lived, one-time token that can be used to authenticate with the Volt and potentially create verifiable credential(s).
-  rpc CreateExchangeToken(CreateExchangeTokenRequest) returns (CreateExchangeTokenResponse);
+  rpc CacheEmailCredential(CacheEmailCredentialRequest) returns (CacheEmailCredentialResponse);
 
   // Delete a DID document or all DID documents originating from a given Volt.
   // Requires \`volt:delete-did\` API privilege.
@@ -1499,20 +1376,25 @@ service SsiAPI {
   rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
 }
 
-message CreateExchangeTokenRequest {
-  // The VC template to use to create a verifiable credential.
-  string vc_template = 1;
+message CacheEmailCredentialRequest {
+  string identity_did = 1;
+
+  string email_address = 2;
+
+  string identity_provider = 3;
+
+  string key_passphrase = 4;
 
   // The time to live for the token, in seconds.
-  uint32 ttl = 2;
+  uint32 ttl = 5;
 }
 
-message CreateExchangeTokenResponse {
+message CacheEmailCredentialResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
-  // The one-time token.
-  string token = 2;
+  // The verifiable credential resource id.
+  string vc_id = 2;
 }
 
 message DeleteDIDRequest {
@@ -2714,7 +2596,7 @@ message AuthenticateRequest {
   // A human-readable name of the entity requesting to authenticate.
   string client_name = 6;
 
-  // Optional challenge code, hashed using SHA-256 and base64 encoded.
+  // Optional challenge code, hashed using SHA-256 and base64 URL encoded (no padding).
   string challenge = 7;
 
   // The host name to add as a SAN to the issued certificate.
@@ -3730,7 +3612,7 @@ message SubscribeWireResponse {
 }
 
 `;
-const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proto_db_sync, proxy_api, relay_api, discovery_api, file, file_api, remote, spark_api, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];
+const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proto_db_sync, proxy_api, relay_api, discovery_api, file, file_api, remote, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];
 
 debug__default["default"]("volt-client-grpc:proto-utils");
 
@@ -4151,11 +4033,6 @@ class GRPCCall extends EventEmitter__default["default"] {
     );
 
     this._call.on("data", (streamResponse) => {
-      if (this._ended) {
-        log$5("ignoring data after end on %s", this._methodName);
-        return;
-      }
-
       try {
         const parsedResponse = _parseResponse.call(
           this,
@@ -4163,6 +4040,13 @@ class GRPCCall extends EventEmitter__default["default"] {
           this._initialRequest.meta,
           streamResponse
         );
+
+        if (this._ended && !parsedResponse.ended) {
+          log$5("ignoring data after end on %s", this._methodName);
+          log$5(parsedResponse);
+          return;
+        }
+
         if (parsedResponse.key_exchange) {
           const peerKey = keyFromPem$2(
             parsedResponse.key_exchange.encryption_key
@@ -4194,9 +4078,6 @@ class GRPCCall extends EventEmitter__default["default"] {
         } else if (parsedResponse.ended) {
           if (parsedResponse.error) {
             this.emit("error", new Error(parsedResponse.error));
-          } else {
-            // Not sure this is necessary - we should receive "end" from grpc soon...
-            this.emit("end");
           }
         } else {
           log$5("method id is %s", parsedResponse.methodId);
@@ -4672,6 +4553,7 @@ function _cleanUp(immediateReconnect) {
   }
 
   if (this._dying) {
+    log$3("dying - clearing reconnect timer");
     clearTimeout(this._reconnectTimer);
   } else if (immediateReconnect || (this._autoRetry && !this._reconnectTimer)) {
     this._reconnectTimer = setTimeout(
@@ -4684,6 +4566,7 @@ function _cleanUp(immediateReconnect) {
   }
 
   if (this.call?.writable) {
+    log$3("ending Connect call");
     this.call.end();
   }
 }
@@ -4774,9 +4657,7 @@ function _doConnect(connectHello) {
   });
 
   this.call.on("end", () => {
-    if (this._connectionId) {
-      this.emit("connected", false);
-    }
+    this.emit("connected", false);
     _cleanUp.call(this);
   });
 
@@ -5106,18 +4987,18 @@ function connectInternal(helloPayload) {
     this._voltConnection.on("connected", (session) => {
       this._session = session;
       this._connected = !!session;
+      this.emit("connected", session);
       if (!this._connected) {
         onDisconnected();
       }
-      this.emit("connected", session);
     });
 
     this._voltConnection.on("error", (err) => {
       // Should auto-reconnect.
       log$2("Volt connection error [%s]", err.message);
       if (this._connected) {
-        onDisconnected();
         this.emit("connected", false);
+        onDisconnected();
       }
 
       if (err.message.endsWith("session invalid")) {
@@ -5546,12 +5427,19 @@ class VoltClient extends EventEmitter__default["default"] {
    * instead of a DID-based authentication session.
    * @param {string} [options.exchangeToken] - optional token to exchange in return for an authenticated session.
    * @param {boolean} [options.waitForAuth] - whether to block and poll on 'prompt' authenticate decisions. Default is true.
+   * @param {boolean} [options.noResolve] - whether to skip resolving the Volt configuration. Default is false.
    */
   async initialise(config, options = {}) {
     log("initialise ", config, options);
 
-    const { ownDID, noDID, didRegistryList, exchangeToken, extraConfig } =
-      options;
+    const {
+      ownDID,
+      noDID,
+      didRegistryList,
+      exchangeToken,
+      extraConfig,
+      noResolve
+    } = options;
     const waitForAuth =
       options.waitForAuth === undefined ? true : !!options.waitForAuth;
 
@@ -5601,10 +5489,12 @@ class VoltClient extends EventEmitter__default["default"] {
         throw new Error("client_name property required in config");
       }
 
-      this._config.volt = await voltUtility.resolveVoltConfig(
-        this._config.volt,
-        didRegistryList
-      );
+      if (!noResolve) {
+        this._config.volt = await voltUtility.resolveVoltConfig(
+          this._config.volt,
+          didRegistryList
+        );
+      }
 
       this._voltConfig = this._config.volt;
 
@@ -5667,7 +5557,7 @@ class VoltClient extends EventEmitter__default["default"] {
         this._credential.saveCache();
       }
 
-      return Promise.resolve(this._config);
+      return Promise.resolve(this.credential.config);
     } catch (err) {
       log("failure starting Volt client [%s]", err.message);
       throw err;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.20.10",
+  "version": "0.20.11",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {

package/src/grpc-call.js

@@ -361,11 +361,6 @@ export default class GRPCCall extends EventEmitter {
     );
 
     this._call.on("data", (streamResponse) => {
-      if (this._ended) {
-        log("ignoring data after end on %s", this._methodName);
-        return;
-      }
-
       try {
         const parsedResponse = _parseResponse.call(
           this,
@@ -373,6 +368,13 @@ export default class GRPCCall extends EventEmitter {
           this._initialRequest.meta,
           streamResponse
         );
+
+        if (this._ended && !parsedResponse.ended) {
+          log("ignoring data after end on %s", this._methodName);
+          log(parsedResponse);
+          return;
+        }
+
         if (parsedResponse.key_exchange) {
           const peerKey = keyFromPem(
             parsedResponse.key_exchange.encryption_key
@@ -404,9 +406,6 @@ export default class GRPCCall extends EventEmitter {
         } else if (parsedResponse.ended) {
           if (parsedResponse.error) {
             this.emit("error", new Error(parsedResponse.error));
-          } else {
-            // Not sure this is necessary - we should receive "end" from grpc soon...
-            this.emit("end");
           }
         } else {
           log("method id is %s", parsedResponse.methodId);

package/src/volt-client-internal.js

@@ -265,18 +265,18 @@ export function connectInternal(helloPayload) {
     this._voltConnection.on("connected", (session) => {
       this._session = session;
       this._connected = !!session;
+      this.emit("connected", session);
       if (!this._connected) {
         onDisconnected();
       }
-      this.emit("connected", session);
     });
 
     this._voltConnection.on("error", (err) => {
       // Should auto-reconnect.
       log("Volt connection error [%s]", err.message);
       if (this._connected) {
-        onDisconnected();
         this.emit("connected", false);
+        onDisconnected();
       }
 
       if (err.message.endsWith("session invalid")) {

package/src/volt-client.js

@@ -1,3 +1,4 @@
+import { resolveVoltConfig } from "@tdxvolt/volt-utility";
 import debug from "debug";
 import EventEmitter from "events";
 import fs from "fs";
@@ -11,7 +12,6 @@ import {
   unaryCallInternal
 } from "./volt-client-internal.js";
 import { VoltCredential } from "./volt-credential.js";
-import { resolveVoltConfig } from "@tdxvolt/volt-utility";
 
 const { readFile } = fs.promises;
 const log = debug("volt-client-grpc:volt-client");
@@ -86,12 +86,19 @@ export class VoltClient extends EventEmitter {
    * instead of a DID-based authentication session.
    * @param {string} [options.exchangeToken] - optional token to exchange in return for an authenticated session.
    * @param {boolean} [options.waitForAuth] - whether to block and poll on 'prompt' authenticate decisions. Default is true.
+   * @param {boolean} [options.noResolve] - whether to skip resolving the Volt configuration. Default is false.
    */
   async initialise(config, options = {}) {
     log("initialise ", config, options);
 
-    const { ownDID, noDID, didRegistryList, exchangeToken, extraConfig } =
-      options;
+    const {
+      ownDID,
+      noDID,
+      didRegistryList,
+      exchangeToken,
+      extraConfig,
+      noResolve
+    } = options;
     const waitForAuth =
       options.waitForAuth === undefined ? true : !!options.waitForAuth;
 
@@ -141,10 +148,12 @@ export class VoltClient extends EventEmitter {
         throw new Error("client_name property required in config");
       }
 
-      this._config.volt = await resolveVoltConfig(
-        this._config.volt,
-        didRegistryList
-      );
+      if (!noResolve) {
+        this._config.volt = await resolveVoltConfig(
+          this._config.volt,
+          didRegistryList
+        );
+      }
 
       this._voltConfig = this._config.volt;
 
@@ -207,7 +216,7 @@ export class VoltClient extends EventEmitter {
         this._credential.saveCache();
       }
 
-      return Promise.resolve(this._config);
+      return Promise.resolve(this.credential.config);
     } catch (err) {
       log("failure starting Volt client [%s]", err.message);
       throw err;

package/src/volt-connection.js

@@ -20,6 +20,7 @@ function _cleanUp(immediateReconnect) {
   }
 
   if (this._dying) {
+    log("dying - clearing reconnect timer");
     clearTimeout(this._reconnectTimer);
   } else if (immediateReconnect || (this._autoRetry && !this._reconnectTimer)) {
     this._reconnectTimer = setTimeout(
@@ -32,6 +33,7 @@ function _cleanUp(immediateReconnect) {
   }
 
   if (this.call?.writable) {
+    log("ending Connect call");
     this.call.end();
   }
 }
@@ -122,9 +124,7 @@ function _doConnect(connectHello) {
   });
 
   this.call.on("end", () => {
-    if (this._connectionId) {
-      this.emit("connected", false);
-    }
+    this.emit("connected", false);
     _cleanUp.call(this);
   });
 

package/src/volt-proto-literals.js

@@ -718,128 +718,6 @@ message RemoteResponse {
     HttpRequest http_request = 5;
   }
 }
-`;
-export const spark_api = `syntax = "proto3";
-
-package tdx.volt_api.volt.v1;
-
-import "tdx/volt_api/volt/v1/status.proto";
-
-// The Spark API allows clients to start and communicate with Spark VMs.
-service SparkAPI {
-  // Start or connect to a spark VM and establish a long-lived communication channel.
-  rpc Spark(stream SparkRequest) returns (stream SparkResponse);
-
-  // Get details of running spark VMs.
-  rpc GetSpark(GetSparkRequest) returns (GetSparkResponse);
-}
-
-// Start a resource-hosted spark.
-// Provenance is determined from the resource owner.
-message StartSparkResource {
-  // The id of the resource containing the VM byte code.
-  string resource_id = 1;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 2;
-
-  // Envelope signature.
-  string signature = 3;
-}
-
-// Start a spark from byte code included in the payload, along with issuer/developer claims and signature.
-message StartSparkAdhoc {
-  // Ad-hoc byte code of VM to run.
-  bytes byte_code = 1;
-
-  // Verifiable credentials associated with this spark.
-  repeated string credential = 2;
-
-  // Envelope signature.
-  string signature = 3;
-
-  // JSON-encoded payload to parameterise the spark.
-  string payload = 4;
-}
-
-// Send commands and payloads to communicate with a running spark.
-message SparkCommand {
-  // Optional id to associate with this command.
-  // If this is omitted, an id will be assigned and returned in the command acknowledgement.
-  string command_id = 1;
-
-  // The command to send to the spark.
-  string command = 2;
-
-  // The command payload.
-  string payload = 3;
-
-  // Command verifiable credential.
-  string credential = 4;
-
-  // Command signature.
-  string signature = 5;
-}
-
-// The request must contain one of the messages indicated below.
-message SparkRequest {
-  oneof payload {
-    StartSparkResource start_resource = 1;
-    StartSparkAdhoc start_adhoc = 2;
-    SparkCommand command = 3;
-  }
-}
-
-// Receive events and payload from a running spark.
-message SparkData {
-  // The command id to which this data corresponds.
-  string command_id = 1;
-
-  oneof payload {
-    // Acknowledges receipt of a spark command.
-    bool acknowledge = 2;
-
-    // Indicates the command has completed.
-    bool ended = 3;
-
-    // Will contain error details on command failure.
-    string error = 4;
-
-    // Data emitted by a command, usually in stringified JSON format.
-    string data = 5;
-  }
-}
-
-// Details of a spark instance.
-message SparkInstance {
-  // The UUID assigned to the spark instance.
-  string spark_id = 1;
-}
-
-// The response will contain one of the messages indicated below.
-message SparkResponse {
-  oneof payload {
-    // Details of any error that occurred on the call.
-    tdx.volt_api.volt.v1.Status status = 1;
-
-    // Details of the spark instance, sent in response to a start command.
-    SparkInstance spark_instance = 2;
-
-    // Payload data emitted by the spark.
-    SparkData spark_data = 3;
-  }
-}
-
-message GetSparkRequest {
-  string spark_id = 1;
-}
-
-// One of the following fields will be present in the response.
-message GetSparkResponse {
-  // Details of any error that occurred on the call.
-  tdx.volt_api.volt.v1.Status status = 1;
-}
-
 `;
 export const ssi = `syntax = "proto3";
 
@@ -915,12 +793,11 @@ export const ssi_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
 
-import "tdx/volt_api/volt/v1/status.proto";
 import "tdx/volt_api/volt/v1/ssi.proto";
+import "tdx/volt_api/volt/v1/status.proto";
 
 service SsiAPI {
-  // Get a short-lived, one-time token that can be used to authenticate with the Volt and potentially create verifiable credential(s).
-  rpc CreateExchangeToken(CreateExchangeTokenRequest) returns (CreateExchangeTokenResponse);
+  rpc CacheEmailCredential(CacheEmailCredentialRequest) returns (CacheEmailCredentialResponse);
 
   // Delete a DID document or all DID documents originating from a given Volt.
   // Requires \`volt:delete-did\` API privilege.
@@ -951,20 +828,25 @@ service SsiAPI {
   rpc SearchDIDRegistry(SearchDIDRegistryRequest) returns (SearchDIDRegistryResponse);
 }
 
-message CreateExchangeTokenRequest {
-  // The VC template to use to create a verifiable credential.
-  string vc_template = 1;
+message CacheEmailCredentialRequest {
+  string identity_did = 1;
+
+  string email_address = 2;
+
+  string identity_provider = 3;
+
+  string key_passphrase = 4;
 
   // The time to live for the token, in seconds.
-  uint32 ttl = 2;
+  uint32 ttl = 5;
 }
 
-message CreateExchangeTokenResponse {
+message CacheEmailCredentialResponse {
   // Details of any error that occurred on the call.
   tdx.volt_api.volt.v1.Status status = 1;
 
-  // The one-time token.
-  string token = 2;
+  // The verifiable credential resource id.
+  string vc_id = 2;
 }
 
 message DeleteDIDRequest {
@@ -2166,7 +2048,7 @@ message AuthenticateRequest {
   // A human-readable name of the entity requesting to authenticate.
   string client_name = 6;
 
-  // Optional challenge code, hashed using SHA-256 and base64 encoded.
+  // Optional challenge code, hashed using SHA-256 and base64 URL encoded (no padding).
   string challenge = 7;
 
   // The host name to add as a SAN to the issued certificate.
@@ -3182,4 +3064,4 @@ message SubscribeWireResponse {
 }
 
 `;
-export const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proto_db_sync, proxy_api, relay_api, discovery_api, file, file_api, remote, spark_api, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];
+export const voltProtos = [sqlite, sqlite_database_api, sqlite_server_api, proto_db_sync, proxy_api, relay_api, discovery_api, file, file_api, remote, ssi, ssi_api, status, sync_api, terminal_api, volt, volt_api, wire_api];