@tdxvolt/volt-client-grpc 0.20.8 → 0.20.10

package/lib/index.cjs

@@ -15,6 +15,7 @@ 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 }; }
 
@@ -135,12 +136,14 @@ function createClient(
   address,
   credentials,
   noSerialise,
-  voltId,
-  serviceId
+  voltId = "",
+  serviceId = ""
 ) {
   let grpcCredentials;
   if (credentials) {
-    const relaying = !!credentials.config?.volt?.relay && !Array.isArray(credentials.config?.volt?.relay);
+    const relaying =
+      !!credentials.config?.volt?.relay &&
+      !Array.isArray(credentials.config?.volt?.relay);
     const ca = relaying
       ? credentials.config?.volt?.relay?.ca_pem
       : credentials.cache.ca;
@@ -1726,6 +1729,7 @@ enum SyncState {
   SYNC_STATE_SYNCING = 1;
   SYNC_STATE_DONE = 2;
   SYNC_STATE_UPDATE = 3;
+  SYNC_STATE_AWARENESS = 4;
 }
 
 message SyncDocumentStart {
@@ -1794,7 +1798,8 @@ message GetDocumentJSONResponse {
     // The current JSON snapshot of the document
     string json = 2;
   }
-}`;
+}
+`;
 const terminal_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
@@ -2737,7 +2742,7 @@ message AuthenticateResponse {
   // This should be persisted by the client, and submitted with all subsequent API calls as part of the call metadata.
   string session_id = 2;
 
-  // The identity id assigned to this authentication.
+  // The 'primary' session identity assigned to this authentication. This will be the DID in DID-based sessions, otherwise it will be the first email-based credential found, if any, otherwise it will be the public key fingerprint.
   string identity_did = 3;
 
   // A certificate issued by the volt CA, binding the request public key to the identity.
@@ -2793,6 +2798,9 @@ message CanAccessResourceResponse {
 
   // The policy decision for this access request.
   PolicyDecision decision = 6;
+
+  // The session that the access relates to.
+  string session_id = 7;
 }
 
 message  CheckCompatibilityRequest {
@@ -3138,6 +3146,9 @@ message GetIdentityResponse {
 message GetOneTimeTokenRequest {
   // Optional token TTL, in seconds. Default is 10 seconds.
   int32 ttl = 1;
+
+  // Optional token context.
+  string context = 2;
 }
 
 message GetOneTimeTokenResponse {
@@ -3200,6 +3211,9 @@ message GetResourceResponse {
 message GetResourcesRequest {
   repeated string id = 1;
 
+  // Wildcards permitted.
+  repeated string alias = 16;
+
   // Wildcards permitted.
   repeated string name = 2;
 
@@ -4844,8 +4858,6 @@ class VoltConnection extends EventEmitter__default["default"] {
 
 const { publicKeyToPem: publicKeyToPem$1, removeCarriageReturn, signBase64 } = js.voltUtils;
 
-const { filter, pick } = lodash__default["default"];
-
 const log$2 = debug__default["default"]("volt-client-grpc:volt-client-internal");
 
 function issueAuthenticate(authenticateRequest, ttl) {
@@ -4918,15 +4930,6 @@ function issueAuthenticate(authenticateRequest, ttl) {
     });
 }
 
-function findDIDDocumentService(document, serviceType) {
-  if (!document.service) {
-    return [];
-  }
-
-  const matches = filter(document.service, (svc) => svc.type === serviceType);
-  return matches;
-}
-
 async function authenticateInternal(
   noDID = false,
   ownDID = false,
@@ -5189,7 +5192,11 @@ function getVoltAPIClientInternal() {
     const serviceAddress = this.isRelayed
       ? this._voltConfig.relay.address
       : this._voltConfig.address;
-    log$2("creating cached VoltAPI service client on %s", serviceAddress);
+    log$2(
+      "creating cached VoltAPI service client on %s for %j",
+      serviceAddress,
+      this._voltConfig
+    );
 
     const serviceDescriptors = getBuiltInServiceDescriptors();
 
@@ -5198,9 +5205,7 @@ function getVoltAPIClientInternal() {
       serviceDescriptors,
       serviceAddress,
       this._credential,
-      this.isRelayed,
-      this._voltConfig?.relay?.cloud ? this._voltConfig.id : "",
-      this._voltConfig?.relay?.cloud ? this._voltConfig.id : ""
+      this.isRelayed
     );
   }
 
@@ -5285,211 +5290,6 @@ function streamingCallInternal(methodType, method, request, service) {
   return call;
 }
 
-async function fetchVoltConfig(discovery_url) {
-  try {
-    const response = await fetch(discovery_url);
-
-    if (!response.ok) {
-      log$2("fetchVoltConfig - error [%s]", response.status);
-      return null;
-    }
-
-    const fullVoltConfig = await response.json();
-
-    if (!fullVoltConfig || typeof fullVoltConfig !== "object") {
-      log$2("fetchVoltConfig - invalid config resolved from: %s", discovery_url);
-      return null;
-    }
-
-    const voltConfig = pick(
-      fullVoltConfig,
-      "id",
-      "display_name",
-      "public_key",
-      "fingerprint",
-      "address",
-      "http_address",
-      "ca_pem",
-      "relay"
-    );
-
-    log$2("fetchVoltConfig from %s", discovery_url);
-
-    return voltConfig;
-  } catch (err) {
-    log$2("fetchVoltConfig - %s error [%s]", discovery_url, err.message);
-    return null;
-  }
-}
-
-async function fetchVoltConfigFromDIDInternal(volt_did, registryUrl) {
-  try {
-    const didResolution = getDIDResolutionURL(volt_did, registryUrl);
-    if (!didResolution) {
-      throw new Error(`Invalid Volt DID: ${volt_did}`);
-    }
-
-    const response = await fetch(didResolution);
-
-    if (!response.ok) {
-      throw new Error(`HTTP error, status: ${response.status}`);
-    }
-
-    const didDocument = await response.json();
-    const voltConfigServices = findDIDDocumentService(
-      didDocument,
-      constants.didServiceType.voltConfig
-    );
-    if (voltConfigServices.length !== 1) {
-      log$2(
-        "Unexpected number of Volt configuration endpoints found in DID document for %s, services found: %d",
-        volt_did,
-        voltConfigServices.length
-      );
-    }
-
-    log$2("resolved DID from %s", didResolution);
-
-    const serviceEndpoint = voltConfigServices[0].serviceEndpoint;
-    const voltConfig = await fetchVoltConfig.call(this, serviceEndpoint);
-    if (!voltConfig) {
-      throw new Error(`failed to resolve Volt config from ${serviceEndpoint}`);
-    }
-
-    return voltConfig;
-  } catch (err) {
-    throw new Error(
-      `Failure fetching Volt config from DID document ${volt_did}: ${err.message}`
-    );
-  }
-}
-
-async function fetchVoltConfigFromDID(volt_did, registryListIn) {
-  let registryList;
-  if (!registryListIn) {
-    //  If no registry list is provided, use the default registry list.
-    registryList = constants.defaultRegistryList;
-  } else {
-    // If a registry list is provided, merge it with the default registry list.
-    registryList = Array.from(
-      new Set(registryListIn.concat(constants.defaultRegistryList))
-    );
-  }
-
-  let voltConfig;
-  for (let registryUrl of registryList) {
-    try {
-      voltConfig = await fetchVoltConfigFromDIDInternal.call(
-        this,
-        volt_did,
-        registryUrl
-      );
-
-      // If we've found a config, break out of the loop.
-      break;
-    } catch (err) {
-      log$2("unable to fetch Volt config from %s: %s", registryUrl, err.message);
-    }
-  }
-
-  if (!voltConfig) {
-    log$2("failed to fetch Volt config for %s from any registry", volt_did);
-  }
-
-  return voltConfig;
-}
-
-async function resolveVoltConfig(cfg, didRegistryList) {
-  // Start by resolving the relay if one is specified.
-  let relay = cfg?.relay?.http_address || cfg?.relay;
-  if (relay) {
-    relay = await resolveVoltConfig.call(this, relay, didRegistryList);
-  }
-
-  let voltDID = "";
-  let voltHttpAddress = "";
-
-  if (typeof cfg === "string") {
-    // If the configuration is a string, determine if it is a DID or HTTP address.
-    if (cfg.indexOf("did:") === 0) {
-      voltDID = cfg;
-    } else {
-      voltHttpAddress = cfg;
-    }
-    cfg = {};
-  } else if (typeof cfg === "object") {
-    voltDID = cfg.id;
-    voltHttpAddress = cfg.http_address;
-  } else {
-    throw new Error("configuration is missing the 'volt' object");
-  }
-
-  let resolvedConfig;
-
-  if (relay) {
-    if (!voltDID) {
-      throw new Error("relay specified but no Volt DID provided");
-    }
-
-    // Build the sub-domain URL for the Volt discovery service by inserting the volt DID into the relay URL.
-    const relayURL = relay.http_address;
-    const relayParts = relayURL.split("://");
-    const subdomain = voltDID.substring(constants.voltDIDPrefix.length);
-    voltHttpAddress = `${relayParts[0]}://${subdomain}.${relayParts[1]}`;
-  } else if (voltDID) {
-    resolvedConfig = await fetchVoltConfigFromDID.call(
-      this,
-      voltDID,
-      didRegistryList
-    );
-  }
-
-  if (!resolvedConfig && voltHttpAddress) {
-    try {
-      resolvedConfig = await fetchVoltConfig.call(
-        this,
-        `${voltHttpAddress}/discover`
-      );
-
-      // Update the http address in the resolved config to the one we used to
-      // fetch it, since we may have used the relay rather than local address.
-      resolvedConfig.http_address = voltHttpAddress;
-    } catch (err) {
-      log$2(
-        "failed to resolve Volt configuration %s [%s]",
-        voltHttpAddress,
-        err.message
-      );
-    }
-  }
-
-  if (!resolvedConfig) {
-    if (cfg.address && cfg.ca_pem) {
-      log$2(
-        "unable to resolve %s / %s, using existing configuration",
-        voltDID,
-        voltHttpAddress
-      );
-    } else {
-      throw new Error(
-        `failed to resolve Volt ${voltDID} / ${voltHttpAddress} and no existing configuration`
-      );
-    }
-  } else {
-    log$2("resolved config from: %s", voltDID || voltHttpAddress);
-    log$2(JSON.stringify(resolvedConfig, null, 2));
-
-    cfg = {
-      ...cfg,
-      ...resolvedConfig
-    };
-  }
-
-  cfg.relay = relay;
-
-  return cfg;
-}
-
 /* eslint-disable no-underscore-dangle */
 
 const {
@@ -5748,6 +5548,8 @@ class VoltClient extends EventEmitter__default["default"] {
    * @param {boolean} [options.waitForAuth] - whether to block and poll on 'prompt' authenticate decisions. Default is true.
    */
   async initialise(config, options = {}) {
+    log("initialise ", config, options);
+
     const { ownDID, noDID, didRegistryList, exchangeToken, extraConfig } =
       options;
     const waitForAuth =
@@ -5799,14 +5601,15 @@ class VoltClient extends EventEmitter__default["default"] {
         throw new Error("client_name property required in config");
       }
 
-      this._config.volt = await resolveVoltConfig.call(
-        this,
+      this._config.volt = await voltUtility.resolveVoltConfig(
         this._config.volt,
         didRegistryList
       );
 
       this._voltConfig = this._config.volt;
 
+      log("config is ", this._voltConfig);
+
       if (!this._voltConfig.id || typeof this._voltConfig.id !== "string") {
         throw new Error("'id' property is missing in Volt configuration");
       }

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.20.8",
+  "version": "0.20.10",
   "description": "tdx Volt library for nodejs clients",
   "type": "module",
   "exports": {
@@ -33,7 +33,8 @@
   "author": "toby.ealden@gmail.com",
   "license": "ISC",
   "dependencies": {
-    "@tdxvolt/volt-client-web": "^0.20.8",
+    "@tdxvolt/volt-client-web": "^0.20.10",
+    "@tdxvolt/volt-utility": "^0.20.10",
     "debug": "^4.1.1",
     "ip": "^1.1.5",
     "jsonwebtoken": "^8.5.1",

package/src/grpc-utils.js

@@ -15,12 +15,14 @@ export function createClient(
   address,
   credentials,
   noSerialise,
-  voltId,
-  serviceId
+  voltId = "",
+  serviceId = ""
 ) {
   let grpcCredentials;
   if (credentials) {
-    const relaying = !!credentials.config?.volt?.relay && !Array.isArray(credentials.config?.volt?.relay);
+    const relaying =
+      !!credentials.config?.volt?.relay &&
+      !Array.isArray(credentials.config?.volt?.relay);
     const ca = relaying
       ? credentials.config?.volt?.relay?.ca_pem
       : credentials.cache.ca;

package/src/volt-client-internal.js

@@ -4,7 +4,6 @@ import debug from "debug";
 import ip from "ip";
 import lodash from "lodash";
 import { v4 as generateId } from "uuid";
-import { constants } from "./constants.js";
 import GRPCCall from "./grpc-call.js";
 import { createClient as createGrpcClient } from "./grpc-utils.js";
 import {
@@ -12,7 +11,6 @@ import {
   getServiceDescriptors
 } from "./proto-utils.js";
 import RpcInvocation from "./rpc-invocation.js";
-import * as voltUtils from "./utils.js";
 import VoltConnection from "./volt-connection.js";
 
 const { publicKeyToPem, removeCarriageReturn, signBase64 } = voltClientUtils;
@@ -91,15 +89,6 @@ function issueAuthenticate(authenticateRequest, ttl) {
     });
 }
 
-function findDIDDocumentService(document, serviceType) {
-  if (!document.service) {
-    return [];
-  }
-
-  const matches = filter(document.service, (svc) => svc.type === serviceType);
-  return matches;
-}
-
 export async function authenticateInternal(
   noDID = false,
   ownDID = false,
@@ -362,7 +351,11 @@ export function getVoltAPIClientInternal() {
     const serviceAddress = this.isRelayed
       ? this._voltConfig.relay.address
       : this._voltConfig.address;
-    log("creating cached VoltAPI service client on %s", serviceAddress);
+    log(
+      "creating cached VoltAPI service client on %s for %j",
+      serviceAddress,
+      this._voltConfig
+    );
 
     const serviceDescriptors = getBuiltInServiceDescriptors();
 
@@ -371,9 +364,7 @@ export function getVoltAPIClientInternal() {
       serviceDescriptors,
       serviceAddress,
       this._credential,
-      this.isRelayed,
-      this._voltConfig?.relay?.cloud ? this._voltConfig.id : "",
-      this._voltConfig?.relay?.cloud ? this._voltConfig.id : ""
+      this.isRelayed
     );
   }
 
@@ -457,208 +448,3 @@ export function streamingCallInternal(methodType, method, request, service) {
 
   return call;
 }
-
-export async function fetchVoltConfig(discovery_url) {
-  try {
-    const response = await fetch(discovery_url);
-
-    if (!response.ok) {
-      log("fetchVoltConfig - error [%s]", response.status);
-      return null;
-    }
-
-    const fullVoltConfig = await response.json();
-
-    if (!fullVoltConfig || typeof fullVoltConfig !== "object") {
-      log("fetchVoltConfig - invalid config resolved from: %s", discovery_url);
-      return null;
-    }
-
-    const voltConfig = pick(
-      fullVoltConfig,
-      "id",
-      "display_name",
-      "public_key",
-      "fingerprint",
-      "address",
-      "http_address",
-      "ca_pem",
-      "relay"
-    );
-
-    log("fetchVoltConfig from %s", discovery_url);
-
-    return voltConfig;
-  } catch (err) {
-    log("fetchVoltConfig - %s error [%s]", discovery_url, err.message);
-    return null;
-  }
-}
-
-async function fetchVoltConfigFromDIDInternal(volt_did, registryUrl) {
-  try {
-    const didResolution = voltUtils.getDIDResolutionURL(volt_did, registryUrl);
-    if (!didResolution) {
-      throw new Error(`Invalid Volt DID: ${volt_did}`);
-    }
-
-    const response = await fetch(didResolution);
-
-    if (!response.ok) {
-      throw new Error(`HTTP error, status: ${response.status}`);
-    }
-
-    const didDocument = await response.json();
-    const voltConfigServices = findDIDDocumentService(
-      didDocument,
-      constants.didServiceType.voltConfig
-    );
-    if (voltConfigServices.length !== 1) {
-      log(
-        "Unexpected number of Volt configuration endpoints found in DID document for %s, services found: %d",
-        volt_did,
-        voltConfigServices.length
-      );
-    }
-
-    log("resolved DID from %s", didResolution);
-
-    const serviceEndpoint = voltConfigServices[0].serviceEndpoint;
-    const voltConfig = await fetchVoltConfig.call(this, serviceEndpoint);
-    if (!voltConfig) {
-      throw new Error(`failed to resolve Volt config from ${serviceEndpoint}`);
-    }
-
-    return voltConfig;
-  } catch (err) {
-    throw new Error(
-      `Failure fetching Volt config from DID document ${volt_did}: ${err.message}`
-    );
-  }
-}
-
-export async function fetchVoltConfigFromDID(volt_did, registryListIn) {
-  let registryList;
-  if (!registryListIn) {
-    //  If no registry list is provided, use the default registry list.
-    registryList = constants.defaultRegistryList;
-  } else {
-    // If a registry list is provided, merge it with the default registry list.
-    registryList = Array.from(
-      new Set(registryListIn.concat(constants.defaultRegistryList))
-    );
-  }
-
-  let voltConfig;
-  for (let registryUrl of registryList) {
-    try {
-      voltConfig = await fetchVoltConfigFromDIDInternal.call(
-        this,
-        volt_did,
-        registryUrl
-      );
-
-      // If we've found a config, break out of the loop.
-      break;
-    } catch (err) {
-      log("unable to fetch Volt config from %s: %s", registryUrl, err.message);
-    }
-  }
-
-  if (!voltConfig) {
-    log("failed to fetch Volt config for %s from any registry", volt_did);
-  }
-
-  return voltConfig;
-}
-
-export async function resolveVoltConfig(cfg, didRegistryList) {
-  // Start by resolving the relay if one is specified.
-  let relay = cfg?.relay?.http_address || cfg?.relay;
-  if (relay) {
-    relay = await resolveVoltConfig.call(this, relay, didRegistryList);
-  }
-
-  let voltDID = "";
-  let voltHttpAddress = "";
-
-  if (typeof cfg === "string") {
-    // If the configuration is a string, determine if it is a DID or HTTP address.
-    if (cfg.indexOf("did:") === 0) {
-      voltDID = cfg;
-    } else {
-      voltHttpAddress = cfg;
-    }
-    cfg = {};
-  } else if (typeof cfg === "object") {
-    voltDID = cfg.id;
-    voltHttpAddress = cfg.http_address;
-  } else {
-    throw new Error("configuration is missing the 'volt' object");
-  }
-
-  let resolvedConfig;
-
-  if (relay) {
-    if (!voltDID) {
-      throw new Error("relay specified but no Volt DID provided");
-    }
-
-    // Build the sub-domain URL for the Volt discovery service by inserting the volt DID into the relay URL.
-    const relayURL = relay.http_address;
-    const relayParts = relayURL.split("://");
-    const subdomain = voltDID.substring(constants.voltDIDPrefix.length);
-    voltHttpAddress = `${relayParts[0]}://${subdomain}.${relayParts[1]}`;
-  } else if (voltDID) {
-    resolvedConfig = await fetchVoltConfigFromDID.call(
-      this,
-      voltDID,
-      didRegistryList
-    );
-  }
-
-  if (!resolvedConfig && voltHttpAddress) {
-    try {
-      resolvedConfig = await fetchVoltConfig.call(
-        this,
-        `${voltHttpAddress}/discover`
-      );
-
-      // Update the http address in the resolved config to the one we used to
-      // fetch it, since we may have used the relay rather than local address.
-      resolvedConfig.http_address = voltHttpAddress;
-    } catch (err) {
-      log(
-        "failed to resolve Volt configuration %s [%s]",
-        voltHttpAddress,
-        err.message
-      );
-    }
-  }
-
-  if (!resolvedConfig) {
-    if (cfg.address && cfg.ca_pem) {
-      log(
-        "unable to resolve %s / %s, using existing configuration",
-        voltDID,
-        voltHttpAddress
-      );
-    } else {
-      throw new Error(
-        `failed to resolve Volt ${voltDID} / ${voltHttpAddress} and no existing configuration`
-      );
-    }
-  } else {
-    log("resolved config from: %s", voltDID || voltHttpAddress);
-    log(JSON.stringify(resolvedConfig, null, 2));
-
-    cfg = {
-      ...cfg,
-      ...resolvedConfig
-    };
-  }
-
-  cfg.relay = relay;
-
-  return cfg;
-}

package/src/volt-client.js

@@ -7,11 +7,11 @@ import {
   authenticateInternal,
   connectInternal,
   getVoltAPIClientInternal,
-  resolveVoltConfig,
   streamingCallInternal,
   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");
@@ -88,6 +88,8 @@ export class VoltClient extends EventEmitter {
    * @param {boolean} [options.waitForAuth] - whether to block and poll on 'prompt' authenticate decisions. Default is true.
    */
   async initialise(config, options = {}) {
+    log("initialise ", config, options);
+
     const { ownDID, noDID, didRegistryList, exchangeToken, extraConfig } =
       options;
     const waitForAuth =
@@ -139,14 +141,15 @@ export class VoltClient extends EventEmitter {
         throw new Error("client_name property required in config");
       }
 
-      this._config.volt = await resolveVoltConfig.call(
-        this,
+      this._config.volt = await resolveVoltConfig(
         this._config.volt,
         didRegistryList
       );
 
       this._voltConfig = this._config.volt;
 
+      log("config is ", this._voltConfig);
+
       if (!this._voltConfig.id || typeof this._voltConfig.id !== "string") {
         throw new Error("'id' property is missing in Volt configuration");
       }

package/src/volt-proto-literals.js

@@ -1181,6 +1181,7 @@ enum SyncState {
   SYNC_STATE_SYNCING = 1;
   SYNC_STATE_DONE = 2;
   SYNC_STATE_UPDATE = 3;
+  SYNC_STATE_AWARENESS = 4;
 }
 
 message SyncDocumentStart {
@@ -1249,7 +1250,8 @@ message GetDocumentJSONResponse {
     // The current JSON snapshot of the document
     string json = 2;
   }
-}`;
+}
+`;
 export const terminal_api = `syntax = "proto3";
 
 package tdx.volt_api.volt.v1;
@@ -2192,7 +2194,7 @@ message AuthenticateResponse {
   // This should be persisted by the client, and submitted with all subsequent API calls as part of the call metadata.
   string session_id = 2;
 
-  // The identity id assigned to this authentication.
+  // The 'primary' session identity assigned to this authentication. This will be the DID in DID-based sessions, otherwise it will be the first email-based credential found, if any, otherwise it will be the public key fingerprint.
   string identity_did = 3;
 
   // A certificate issued by the volt CA, binding the request public key to the identity.
@@ -2248,6 +2250,9 @@ message CanAccessResourceResponse {
 
   // The policy decision for this access request.
   PolicyDecision decision = 6;
+
+  // The session that the access relates to.
+  string session_id = 7;
 }
 
 message  CheckCompatibilityRequest {
@@ -2593,6 +2598,9 @@ message GetIdentityResponse {
 message GetOneTimeTokenRequest {
   // Optional token TTL, in seconds. Default is 10 seconds.
   int32 ttl = 1;
+
+  // Optional token context.
+  string context = 2;
 }
 
 message GetOneTimeTokenResponse {
@@ -2655,6 +2663,9 @@ message GetResourceResponse {
 message GetResourcesRequest {
   repeated string id = 1;
 
+  // Wildcards permitted.
+  repeated string alias = 16;
+
   // Wildcards permitted.
   repeated string name = 2;