@eluvio/elv-client-js 3.1.96 → 3.2.1

package/package.json

@@ -1,15 +1,17 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "3.1.96",
+  "version": "3.2.1",
   "description": "Javascript client for the Eluvio Content Fabric",
-  "main": "src/ElvClient.js",
+  "main": "src/index.js",
   "author": "Kevin Talmadge",
   "license": "MIT",
   "homepage": "https://github.com/eluv-io/elv-client-js",
   "scripts": {
     "bump-version": "npm --git-tag-version --no-commit-hooks version patch",
     "build": "npm run build-docs && npm run build-dist && npm run build-frame-client && npm run build-permissions-client && npm run build-prod",
-    "build-docs": "node build/BuildDocs.js && ./node_modules/.bin/jsdoc --configure ./.jsdoc.json --readme README.md",
+    "build-docs": "node build/BuildDocs.js && npm run build-client-docs && npm run build-wallet-client-docs",
+    "build-client-docs": "./node_modules/.bin/jsdoc --configure ./.jsdoc.json --readme README.md",
+    "build-wallet-client-docs": "./node_modules/.bin/jsdoc --configure ./.jsdoc-mc.json --readme ./src/walletClient/README.md",
     "build-dist": "node ./node_modules/@babel/cli/bin/babel.js --source-type=unambiguous --presets=@babel/preset-env --plugins @babel/plugin-transform-runtime src --out-dir dist/src",
     "build-contracts": "node build/BuildContracts.js",
     "build-frame-client": "webpack -p --progress --entry ./dist/src/FrameClient.js --output-filename ElvFrameClient-min.js --devtool none --optimize-minimize && mv test/bundle-analysis/index.html test/bundle-analysis/frame-client.html",

package/src/ElvClient.js

@@ -39,6 +39,9 @@ if(Utils.Platform() === Utils.PLATFORM_NODE) {
 /**
  * See the Modules section on the sidebar for details about methods related to interacting with the Fabric.
  *
+ * <br/>
+ *
+ * For information about the Eluvio Wallet Client, go <a href="wallet-client/index.html">here</a>.
  */
 class ElvClient {
   Log(message, error = false) {
@@ -116,7 +119,7 @@ class ElvClient {
   /**
    * Create a new ElvClient
    *
-   * NOTE: It is highly recommended to use ElvClient.FromConfiguration to
+   * NOTE: It is highly recommended to use the <a href="#.FromConfigurationUrl">FromConfigurationUrl</a> or <a href="#.FromNetworkName">FromNetworkName</a> method
    * automatically import the client settings from the fabric
    *
    * @constructor

package/src/Utils.js

@@ -4,6 +4,7 @@ const bs58 = require("bs58");
 const BigNumber = require("bignumber.js").default;
 const VarInt = require("varint");
 const URI = require("urijs");
+const Pako = require("pako");
 
 const {
   keccak256,
@@ -17,14 +18,14 @@ const {
  *
  * Utils can be imported separately from the client:
  *
- * const Utils = require("@eluvio/elv-client-js/src/Utils)
+ * `const Utils = require("@eluvio/elv-client-js/src/Utils)`
  *
  * or
  *
- * import Utils from "@eluvio/elv-client-js/src/Utils"
+ * `import Utils from "@eluvio/elv-client-js/src/Utils"`
  *
  *
- * It can be accessed from ElvClient and FrameClient as client.utils
+ * It can be accessed from ElvClient and FrameClient as `client.utils`
  */
 const Utils = {
   name: "Utils",
@@ -150,6 +151,27 @@ const Utils = {
     };
   },
 
+
+  /**
+   * Decode the specified signed token into its component parts
+   *
+   * @param {string} token - The token to decode
+   *
+   * @return {Object} - Components of the signed token
+   */
+  DecodeSignedToken: (token) => {
+    const decodedToken = Utils.FromB58(token.slice(6));
+    const signature = `0x${decodedToken.slice(0, 65).toString("hex")}`;
+
+    let payload = JSON.parse(Buffer.from(Pako.inflateRaw(decodedToken.slice(65))).toString("utf-8"));
+    payload.adr = Utils.FormatAddress(`0x${Buffer.from(payload.adr, "base64").toString("hex")}`);
+
+    return {
+      payload,
+      signature
+    };
+  },
+
   /**
    * Decode the specified write token into its component parts
    *
@@ -420,6 +442,21 @@ const Utils = {
     return Buffer.from(str, "base64").toString("utf-8");
   },
 
+  FromB64URL: str => {
+    str = str.replace(/-/g, "+").replace(/_/g, "/");
+
+    const pad = str.length % 4;
+    if(pad) {
+      if(pad === 1) {
+        throw new Error("InvalidLengthError: Input base64url string is the wrong length to determine padding");
+      }
+
+      str += new Array(5-pad).join("=");
+    }
+
+    return Utils.FromB64(str);
+  },
+
   B58: arr => {
     return bs58.encode(Buffer.from(arr));
   },
@@ -428,6 +465,10 @@ const Utils = {
     return bs58.decode(str);
   },
 
+  FromB58ToStr: str => {
+    return new TextDecoder().decode(Utils.FromB58(str));
+  },
+
   /**
    * Decode the given fabric authorization token
    *

package/src/index.js

@@ -0,0 +1,7 @@
+const {ElvClient} = require("./ElvClient.js");
+const {ElvMarketplaceClient} = require("./walletClient/index.js");
+const Utils = require("./Utils.js");
+
+exports.ElvClient = ElvClient;
+exports.ElvMarketplaceClient = ElvMarketplaceClient;
+exports.Utils = Utils;