@eluvio/elv-client-js 4.0.22 → 4.0.24

package/dist/src/ElvClient.js

@@ -134,8 +134,8 @@ var ElvClient = /*#__PURE__*/function () {
    * @param {string} configUrl - Full URL to the config endpoint
    * @param {Array<string>} kmsUrls - List of KMS urls to use for OAuth authentication
    * @param {string=} region - Preferred region - the fabric will auto-detect the best region if not specified
-   * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
-   *
+   * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
+   * @param {string=} clientIP - IP address to use in determining the region to use
    * @return {Promise<Object>} - Object containing content space ID and fabric and ethereum URLs
    */
   _createClass(ElvClient, [{
@@ -318,12 +318,12 @@ var ElvClient = /*#__PURE__*/function () {
     /**
      * Update fabric URLs to prefer the specified region.
      *
-     * Note: Client must have been initialized with FromConfiguration
+     * Note: Client must have been initialized with FromConfigurationUrl or FromNetworkName
      *
      * @methodGroup Nodes
      * @namedParams
      * @param {string} region - Preferred region - the fabric will auto-detect the best region if not specified
-     * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
+     * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
      *
      * @return {Promise<Object>} - An object containing the updated fabric, ethereum, auth service, and search URLs in order of preference
      */
@@ -380,7 +380,7 @@ var ElvClient = /*#__PURE__*/function () {
     /**
      * Reset fabric URLs to prefer the best region auto-detected by the fabric.
      *
-     * Note: Client must have been initialized with FromConfiguration
+     * Note: Client must have been initialized with FromConfigurationUrl or FromNetworkName
      *
      * @methodGroup Nodes
      *
@@ -419,7 +419,7 @@ var ElvClient = /*#__PURE__*/function () {
     /**
      * Retrieve the node ID reported by the fabric for the specified region
      *
-     * Note: Client must have been initialized with FromConfiguration
+     * Note: Client must have been initialized with FromConfigurationUrl or FromNetworkName
      *
      * @methodGroup Nodes
      *
@@ -1068,7 +1068,7 @@ var ElvClient = /*#__PURE__*/function () {
      * Set the signer for this client via OAuth token. The client will exchange the given token
      * for the user's private key using the KMS specified in the configuration.
      *
-     * NOTE: The KMS URL(s) must be set in the initial configuration of the client (FromConfigurationUrl)
+     * NOTE: The KMS URL(s) must be set in the initial configuration of the client (FromConfigurationUrl or FromNetworkName)
      *
      * @methodGroup Authorization
      * @namedParams
@@ -1489,20 +1489,23 @@ var ElvClient = /*#__PURE__*/function () {
     key: "Configuration",
     value: function () {
       var _Configuration = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee21(_ref22) {
-        var configUrl, _ref22$kmsUrls, kmsUrls, region, uri, fabricInfo, filterHTTPS, fabricURIs, ethereumURIs, authServiceURIs, searchURIs, fabricVersion;
+        var configUrl, _ref22$kmsUrls, kmsUrls, region, clientIP, uri, fabricInfo, filterHTTPS, fabricURIs, ethereumURIs, authServiceURIs, searchURIs, fabricVersion;
         return _regeneratorRuntime.wrap(function _callee21$(_context21) {
           while (1) switch (_context21.prev = _context21.next) {
             case 0:
-              configUrl = _ref22.configUrl, _ref22$kmsUrls = _ref22.kmsUrls, kmsUrls = _ref22$kmsUrls === void 0 ? [] : _ref22$kmsUrls, region = _ref22.region;
+              configUrl = _ref22.configUrl, _ref22$kmsUrls = _ref22.kmsUrls, kmsUrls = _ref22$kmsUrls === void 0 ? [] : _ref22$kmsUrls, region = _ref22.region, clientIP = _ref22.clientIP;
               _context21.prev = 1;
               uri = new URI(configUrl);
               uri.pathname("/config");
               if (region) {
                 uri.addSearch("elvgeo", region);
               }
-              _context21.next = 7;
+              if (clientIP) {
+                uri.addSearch("client_ip", clientIP);
+              }
+              _context21.next = 8;
               return Utils.ResponseToJson(HttpClient.Fetch(uri.toString()));
-            case 7:
+            case 8:
               fabricInfo = _context21.sent;
               // If any HTTPS urls present, throw away HTTP urls so only HTTPS will be used
               filterHTTPS = function filterHTTPS(uri) {
@@ -1534,19 +1537,19 @@ var ElvClient = /*#__PURE__*/function () {
                 searchURIs: searchURIs,
                 fabricVersion: fabricVersion
               });
-            case 20:
-              _context21.prev = 20;
+            case 21:
+              _context21.prev = 21;
               _context21.t0 = _context21["catch"](1);
               // eslint-disable-next-line no-console
               console.error("Error retrieving fabric configuration:");
               // eslint-disable-next-line no-console
               console.error(_context21.t0);
               throw _context21.t0;
-            case 25:
+            case 26:
             case "end":
               return _context21.stop();
           }
-        }, _callee21, null, [[1, 20]]);
+        }, _callee21, null, [[1, 21]]);
       }));
       function Configuration(_x18) {
         return _Configuration.apply(this, arguments);
@@ -1560,7 +1563,8 @@ var ElvClient = /*#__PURE__*/function () {
      * @namedParams
      * @param {string} networkName - Name of the network to connect to ("main", "demo", "test)
      * @param {string=} region - Preferred region - the fabric will auto-detect the best region if not specified
-     * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
+     * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
+     * @param {string=} clientIP - IP address to use in determining the region to use
      * @param {string=} trustAuthorityId - (OAuth) The ID of the trust authority to use for OAuth authentication   * @param {boolean=} noCache=false - If enabled, blockchain transactions will not be cached
      * @param {string=} staticToken - Static token that will be used for all authorization in place of normal auth
      * @param {number=} ethereumContractTimeout=10 - Number of seconds to wait for contract calls
@@ -1572,11 +1576,11 @@ var ElvClient = /*#__PURE__*/function () {
     key: "FromNetworkName",
     value: function () {
       var _FromNetworkName = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee22(_ref23) {
-        var networkName, region, trustAuthorityId, staticToken, _ref23$ethereumContra, ethereumContractTimeout, _ref23$noCache, noCache, _ref23$noAuth, noAuth, assumeV3, configUrl;
+        var networkName, region, clientIP, trustAuthorityId, staticToken, _ref23$ethereumContra, ethereumContractTimeout, _ref23$noCache, noCache, _ref23$noAuth, noAuth, assumeV3, configUrl;
         return _regeneratorRuntime.wrap(function _callee22$(_context22) {
           while (1) switch (_context22.prev = _context22.next) {
             case 0:
-              networkName = _ref23.networkName, region = _ref23.region, trustAuthorityId = _ref23.trustAuthorityId, staticToken = _ref23.staticToken, _ref23$ethereumContra = _ref23.ethereumContractTimeout, ethereumContractTimeout = _ref23$ethereumContra === void 0 ? 10 : _ref23$ethereumContra, _ref23$noCache = _ref23.noCache, noCache = _ref23$noCache === void 0 ? false : _ref23$noCache, _ref23$noAuth = _ref23.noAuth, noAuth = _ref23$noAuth === void 0 ? false : _ref23$noAuth, assumeV3 = _ref23.assumeV3;
+              networkName = _ref23.networkName, region = _ref23.region, clientIP = _ref23.clientIP, trustAuthorityId = _ref23.trustAuthorityId, staticToken = _ref23.staticToken, _ref23$ethereumContra = _ref23.ethereumContractTimeout, ethereumContractTimeout = _ref23$ethereumContra === void 0 ? 10 : _ref23$ethereumContra, _ref23$noCache = _ref23.noCache, noCache = _ref23$noCache === void 0 ? false : _ref23$noCache, _ref23$noAuth = _ref23.noAuth, noAuth = _ref23$noAuth === void 0 ? false : _ref23$noAuth, assumeV3 = _ref23.assumeV3;
               configUrl = networks[networkName];
               if (configUrl) {
                 _context22.next = 4;
@@ -1588,6 +1592,7 @@ var ElvClient = /*#__PURE__*/function () {
               return this.FromConfigurationUrl({
                 configUrl: configUrl,
                 region: region,
+                clientIP: clientIP,
                 trustAuthorityId: trustAuthorityId,
                 staticToken: staticToken,
                 ethereumContractTimeout: ethereumContractTimeout,
@@ -1615,7 +1620,8 @@ var ElvClient = /*#__PURE__*/function () {
      * @namedParams
      * @param {string} configUrl - Full URL to the config endpoint
      * @param {string=} region - Preferred region - the fabric will auto-detect the best region if not specified
-     * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
+     * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
+     * @param {string=} clientIP - IP address to use in determining the region to use
      * @param {string=} trustAuthorityId - (OAuth) The ID of the trust authority to use for OAuth authentication   * @param {boolean=} noCache=false - If enabled, blockchain transactions will not be cached
      * @param {string=} staticToken - Static token that will be used for all authorization in place of normal auth
      * @param {number=} ethereumContractTimeout=10 - Number of seconds to wait for contract calls
@@ -1627,14 +1633,15 @@ var ElvClient = /*#__PURE__*/function () {
     key: "FromConfigurationUrl",
     value: function () {
       var _FromConfigurationUrl = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee23(_ref24) {
-        var configUrl, region, trustAuthorityId, staticToken, _ref24$ethereumContra, ethereumContractTimeout, _ref24$noCache, noCache, _ref24$noAuth, noAuth, _ref24$assumeV, assumeV3, _yield$ElvClient$Conf3, contentSpaceId, networkId, networkName, fabricURIs, ethereumURIs, authServiceURIs, searchURIs, fabricVersion, client;
+        var configUrl, region, clientIP, trustAuthorityId, staticToken, _ref24$ethereumContra, ethereumContractTimeout, _ref24$noCache, noCache, _ref24$noAuth, noAuth, _ref24$assumeV, assumeV3, _yield$ElvClient$Conf3, contentSpaceId, networkId, networkName, fabricURIs, ethereumURIs, authServiceURIs, searchURIs, fabricVersion, client;
         return _regeneratorRuntime.wrap(function _callee23$(_context23) {
           while (1) switch (_context23.prev = _context23.next) {
             case 0:
-              configUrl = _ref24.configUrl, region = _ref24.region, trustAuthorityId = _ref24.trustAuthorityId, staticToken = _ref24.staticToken, _ref24$ethereumContra = _ref24.ethereumContractTimeout, ethereumContractTimeout = _ref24$ethereumContra === void 0 ? 10 : _ref24$ethereumContra, _ref24$noCache = _ref24.noCache, noCache = _ref24$noCache === void 0 ? false : _ref24$noCache, _ref24$noAuth = _ref24.noAuth, noAuth = _ref24$noAuth === void 0 ? false : _ref24$noAuth, _ref24$assumeV = _ref24.assumeV3, assumeV3 = _ref24$assumeV === void 0 ? false : _ref24$assumeV;
+              configUrl = _ref24.configUrl, region = _ref24.region, clientIP = _ref24.clientIP, trustAuthorityId = _ref24.trustAuthorityId, staticToken = _ref24.staticToken, _ref24$ethereumContra = _ref24.ethereumContractTimeout, ethereumContractTimeout = _ref24$ethereumContra === void 0 ? 10 : _ref24$ethereumContra, _ref24$noCache = _ref24.noCache, noCache = _ref24$noCache === void 0 ? false : _ref24$noCache, _ref24$noAuth = _ref24.noAuth, noAuth = _ref24$noAuth === void 0 ? false : _ref24$noAuth, _ref24$assumeV = _ref24.assumeV3, assumeV3 = _ref24$assumeV === void 0 ? false : _ref24$assumeV;
               _context23.next = 3;
               return ElvClient.Configuration({
                 configUrl: configUrl,
+                clientIP: clientIP,
                 region: region
               });
             case 3:

package/dist/src/client/Files.js

@@ -1118,7 +1118,8 @@ exports.DownloadFile = /*#__PURE__*/function () {
             libraryId: libraryId,
             objectId: objectId,
             versionHash: versionHash,
-            encryption: encryption
+            encryption: encryption,
+            makeAccessRequest: encryption === "cgck"
           });
         case 12:
           headers = _context15.sent;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "4.0.22",
+  "version": "4.0.24",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/index.js",
   "author": "Kevin Talmadge",

package/src/ElvClient.js

@@ -203,14 +203,15 @@ class ElvClient {
    * @param {string} configUrl - Full URL to the config endpoint
    * @param {Array<string>} kmsUrls - List of KMS urls to use for OAuth authentication
    * @param {string=} region - Preferred region - the fabric will auto-detect the best region if not specified
-   * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
-   *
+   * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
+   * @param {string=} clientIP - IP address to use in determining the region to use
    * @return {Promise<Object>} - Object containing content space ID and fabric and ethereum URLs
    */
   static async Configuration({
     configUrl,
     kmsUrls=[],
-    region
+    region,
+    clientIP
   }) {
     try {
       const uri = new URI(configUrl);
@@ -220,6 +221,10 @@ class ElvClient {
         uri.addSearch("elvgeo", region);
       }
 
+      if(clientIP) {
+        uri.addSearch("client_ip", clientIP);
+      }
+
       const fabricInfo = await Utils.ResponseToJson(
         HttpClient.Fetch(uri.toString())
       );
@@ -275,7 +280,8 @@ class ElvClient {
    * @namedParams
    * @param {string} networkName - Name of the network to connect to ("main", "demo", "test)
    * @param {string=} region - Preferred region - the fabric will auto-detect the best region if not specified
-   * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
+   * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
+   * @param {string=} clientIP - IP address to use in determining the region to use
    * @param {string=} trustAuthorityId - (OAuth) The ID of the trust authority to use for OAuth authentication   * @param {boolean=} noCache=false - If enabled, blockchain transactions will not be cached
    * @param {string=} staticToken - Static token that will be used for all authorization in place of normal auth
    * @param {number=} ethereumContractTimeout=10 - Number of seconds to wait for contract calls
@@ -286,6 +292,7 @@ class ElvClient {
   static async FromNetworkName({
     networkName,
     region,
+    clientIP,
     trustAuthorityId,
     staticToken,
     ethereumContractTimeout=10,
@@ -300,6 +307,7 @@ class ElvClient {
     return await this.FromConfigurationUrl({
       configUrl,
       region,
+      clientIP,
       trustAuthorityId,
       staticToken,
       ethereumContractTimeout,
@@ -316,7 +324,8 @@ class ElvClient {
    * @namedParams
    * @param {string} configUrl - Full URL to the config endpoint
    * @param {string=} region - Preferred region - the fabric will auto-detect the best region if not specified
-   * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
+   * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
+   * @param {string=} clientIP - IP address to use in determining the region to use
    * @param {string=} trustAuthorityId - (OAuth) The ID of the trust authority to use for OAuth authentication   * @param {boolean=} noCache=false - If enabled, blockchain transactions will not be cached
    * @param {string=} staticToken - Static token that will be used for all authorization in place of normal auth
    * @param {number=} ethereumContractTimeout=10 - Number of seconds to wait for contract calls
@@ -327,6 +336,7 @@ class ElvClient {
   static async FromConfigurationUrl({
     configUrl,
     region,
+    clientIP,
     trustAuthorityId,
     staticToken,
     ethereumContractTimeout=10,
@@ -345,6 +355,7 @@ class ElvClient {
       fabricVersion
     } = await ElvClient.Configuration({
       configUrl,
+      clientIP,
       region
     });
 
@@ -425,12 +436,12 @@ class ElvClient {
   /**
    * Update fabric URLs to prefer the specified region.
    *
-   * Note: Client must have been initialized with FromConfiguration
+   * Note: Client must have been initialized with FromConfigurationUrl or FromNetworkName
    *
    * @methodGroup Nodes
    * @namedParams
    * @param {string} region - Preferred region - the fabric will auto-detect the best region if not specified
-   * - Available regions: as-east au-east eu-east-north eu-west-north na-east-north na-east-south na-west-north na-west-south eu-east-south eu-west-south
+   * - Available regions: as-east, au-east, eu-east-north, eu-west-north, na-east-north, na-east-south, na-west-north, na-west-south, eu-east-south, eu-west-south
    *
    * @return {Promise<Object>} - An object containing the updated fabric, ethereum, auth service, and search URLs in order of preference
    */
@@ -465,7 +476,7 @@ class ElvClient {
   /**
    * Reset fabric URLs to prefer the best region auto-detected by the fabric.
    *
-   * Note: Client must have been initialized with FromConfiguration
+   * Note: Client must have been initialized with FromConfigurationUrl or FromNetworkName
    *
    * @methodGroup Nodes
    *
@@ -482,7 +493,7 @@ class ElvClient {
   /**
    * Retrieve the node ID reported by the fabric for the specified region
    *
-   * Note: Client must have been initialized with FromConfiguration
+   * Note: Client must have been initialized with FromConfigurationUrl or FromNetworkName
    *
    * @methodGroup Nodes
    *
@@ -898,7 +909,7 @@ class ElvClient {
    * Set the signer for this client via OAuth token. The client will exchange the given token
    * for the user's private key using the KMS specified in the configuration.
    *
-   * NOTE: The KMS URL(s) must be set in the initial configuration of the client (FromConfigurationUrl)
+   * NOTE: The KMS URL(s) must be set in the initial configuration of the client (FromConfigurationUrl or FromNetworkName)
    *
    * @methodGroup Authorization
    * @namedParams

package/src/client/Files.js

@@ -684,7 +684,7 @@ exports.DownloadFile = async function({
       UrlJoin("q", writeToken || versionHash || objectId, "files", filePath);
 
 
-  const headers = await this.authClient.AuthorizationHeader({libraryId, objectId, versionHash, encryption});
+  const headers = await this.authClient.AuthorizationHeader({libraryId, objectId, versionHash, encryption, makeAccessRequest: encryption === "cgck"});
   headers.Accept = "*/*";
 
   // If not owner, indicate re-encryption