@eluvio/elv-client-js 4.0.121 → 4.0.123

package/dist/src/walletClient/index.js

@@ -7,8 +7,8 @@ var _asyncToGenerator = require("@babel/runtime/helpers/asyncToGenerator");
 var _classCallCheck = require("@babel/runtime/helpers/classCallCheck");
 var _createClass = require("@babel/runtime/helpers/createClass");
 var _excluded = ["code", "address", "type", "authToken", "expiresAt"];
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 var _require = require("../ElvClient"),
   ElvClient = _require.ElvClient;
 var Configuration = require("./Configuration");
@@ -79,7 +79,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
     this.utils = client.utils;
     this.ForbiddenMethods = ElvWalletClient.ForbiddenMethods;
   }
-  return _createClass(ElvWalletClient, [{
+  _createClass(ElvWalletClient, [{
     key: "Log",
     value: function Log(message) {
       var error = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
@@ -136,7 +136,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
      */
   }, {
     key: "PersonalSign",
-    value: (function () {
+    value: function () {
       var _PersonalSign = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3(_ref2) {
         var message, parameters, url;
         return _regeneratorRuntime.wrap(function _callee3$(_context3) {
@@ -265,7 +265,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
         return _PersonalSign.apply(this, arguments);
       }
       return PersonalSign;
-    }())
+    }()
   }, {
     key: "LogInURL",
     value: function () {
@@ -344,7 +344,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
      */
   }, {
     key: "LogIn",
-    value: (function () {
+    value: function () {
       var _LogIn = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee7(_ref5) {
         var _this = this;
         var _ref5$method, method, provider, _ref5$mode, mode, callbackUrl, marketplaceParams, _ref5$clearLogin, clearLogin, callback, loginUrl;
@@ -463,10 +463,9 @@ var ElvWalletClient = /*#__PURE__*/function () {
      *
      * @methodGroup Login
      */
-    )
   }, {
     key: "LogOut",
-    value: (function () {
+    value: function () {
       var _LogOut = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee8() {
         return _regeneratorRuntime.wrap(function _callee8$(_context8) {
           while (1) switch (_context8.prev = _context8.next) {
@@ -509,7 +508,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
         return _LogOut.apply(this, arguments);
       }
       return LogOut;
-    }())
+    }()
   }, {
     key: "TokenStatus",
     value: function () {
@@ -549,7 +548,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
      */
   }, {
     key: "Authenticate",
-    value: (function () {
+    value: function () {
       var _Authenticate = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee10(_ref7) {
         var token, decodedToken;
         return _regeneratorRuntime.wrap(function _callee10$(_context10) {
@@ -615,10 +614,9 @@ var ElvWalletClient = /*#__PURE__*/function () {
      * - signingToken - Identical to `authToken`, but also includes the ability to perform arbitrary signatures with the custodial wallet. This token should be protected and should not be
      * shared with third parties.
      */
-    )
   }, {
     key: "AuthenticateOAuth",
-    value: (function () {
+    value: function () {
       var _AuthenticateOAuth = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee11(_ref8) {
         var idToken, tenantId, email, signerURIs, _ref8$shareEmail, shareEmail, _ref8$extraData, extraData, nonce, _ref8$createRemoteTok, createRemoteToken, _ref8$force, force, tokenDuration, fabricToken, expiresAt, tokenResponse, address, decodedToken;
         return _regeneratorRuntime.wrap(function _callee11$(_context11) {
@@ -746,10 +744,9 @@ var ElvWalletClient = /*#__PURE__*/function () {
      * @returns {Promise<string>} - Returns an authorization token that can be used to initialize the client using <a href="#Authenticate">Authenticate</a>.
      * Save this token to avoid having to reauthenticate. This token expires after 24 hours.
      */
-    )
   }, {
     key: "AuthenticateExternalWallet",
-    value: (function () {
+    value: function () {
       var _AuthenticateExternalWallet = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee13(_ref9) {
         var _this2 = this;
         var address, _ref9$tokenDuration, tokenDuration, _ref9$walletName, walletName, Sign, expiresAt, fabricToken;
@@ -818,7 +815,6 @@ var ElvWalletClient = /*#__PURE__*/function () {
      *
      * @returns {string} - The client auth token
      */
-    )
   }, {
     key: "ClientAuthToken",
     value: function ClientAuthToken() {
@@ -1882,7 +1878,7 @@ var ElvWalletClient = /*#__PURE__*/function () {
      */
   }, {
     key: "Initialize",
-    value: (function () {
+    value: function () {
       var _Initialize = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee25(_ref24) {
         var client, _ref24$appId, appId, _ref24$network, network, _ref24$mode, mode, localization, marketplaceParams, previewMarketplaceId, _ref24$storeAuthToken, storeAuthToken, _ref24$skipMarketplac, skipMarketplaceLoad, _ref25, tenantSlug, marketplaceSlug, marketplaceId, marketplaceHash, previewMarketplaceHash, walletClient, url, savedToken;
         return _regeneratorRuntime.wrap(function _callee25$(_context25) {
@@ -2009,8 +2005,9 @@ var ElvWalletClient = /*#__PURE__*/function () {
         return _Initialize.apply(this, arguments);
       }
       return Initialize;
-    }())
+    }()
   }]);
+  return ElvWalletClient;
 }();
 Object.assign(ElvWalletClient.prototype, require("./ClientMethods"));
 Object.assign(ElvWalletClient.prototype, require("./Profile"));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "4.0.121",
+  "version": "4.0.123",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/index.js",
   "author": "Kevin Talmadge",
@@ -9,7 +9,7 @@
   "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-wallet-client-web && npm run build-wallet-client-node && npm run build-prod",
-    "build-docs": "node build/BuildDocs.js && npm run build-client-docs && npm run build-wallet-client-docs",
+    "build-docs": "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",

package/src/AuthorizationClient.js

@@ -130,6 +130,8 @@ class AuthorizationClient {
     // User wallet requests can't use static token
     if(this.client.staticToken && !isWalletRequest && !update) {
       return this.client.staticToken;
+    } else if(this.client.staticUpdateToken && !isWalletRequest) {
+      return this.client.staticUpdateToken;
     }
 
     const initialNoCache = this.noCache;

package/src/ElvClient.js

@@ -750,6 +750,9 @@ class ElvClient {
     signer.provider.pollingInterval = 500;
     this.signer = signer;
 
+    this.CreateFabricToken({})
+      .then(token => this.signedToken = token);
+
     if(reset) {
       this.InitializeClients();
     }
@@ -1195,13 +1198,16 @@ class ElvClient {
    * @methodGroup Authorization
    * @namedParams
    * @param {string=} token - The static token to use. If not provided, the default static token will be set.
+   * @param {boolean=} update=false - If specified, the static token will be used for update operations as well
    */
-  SetStaticToken({token}={}) {
+  SetStaticToken({token, update=false}={}) {
     if(token) {
       this.staticToken = token;
     } else {
       this.staticToken = this.utils.B64(JSON.stringify({qspace_id: this.contentSpaceId}));
     }
+
+    this.staticUpdateToken = update ? this.staticToken : undefined;
   }
 
   /**
@@ -1299,8 +1305,11 @@ class ElvClient {
     );
   }
 
-  async MakeAuthServiceRequest({kmsId, objectId, versionHash, method="GET", path, bodyType, body={}, queryParams={}, headers}) {
-    return this.authClient.MakeAuthServiceRequest({kmsId, objectId, versionHash, method, path, bodyType, body, queryParams, headers});
+  async MakeAuthServiceRequest({kmsId, objectId, versionHash, method="GET", path, bodyType, body={}, queryParams={}, headers, format}) {
+    const response = this.authClient.MakeAuthServiceRequest({kmsId, objectId, versionHash, method, path, bodyType, body, queryParams, headers});
+
+    return !format ? response :
+      this.utils.ResponseToFormat(format, response);
   }
 
   /* FrameClient related */
@@ -1416,5 +1425,6 @@ Object.assign(ElvClient.prototype, require("./client/LiveStream"));
 Object.assign(ElvClient.prototype, require("./client/ContentManagement"));
 Object.assign(ElvClient.prototype, require("./client/NTP"));
 Object.assign(ElvClient.prototype, require("./client/NFT"));
+Object.assign(ElvClient.prototype, require("./client/Shares"));
 
 exports.ElvClient = ElvClient;

package/src/FrameClient.js

@@ -375,6 +375,7 @@ class FrameClient {
       "CreateNonOwnerCap",
       "CreatePart",
       "CreateProductionMaster",
+      "CreateShare",
       "CreateSignedToken",
       "CreateStaticToken",
       "CurrentAccountAddress",
@@ -452,6 +453,7 @@ class FrameClient {
       "QParts",
       "RecordWriteToken",
       "RedeemCode",
+      "RedeemShareToken",
       "RemoveAccessGroupManager",
       "RemoveAccessGroupMember",
       "RemoveContentObjectGroupPermission",
@@ -462,6 +464,7 @@ class FrameClient {
       "ReplaceMetadata",
       "Request",
       "ResetRegion",
+      "RevokeShare",
       "SendFunds",
       "SetAccessCharge",
       "SetAuth",
@@ -478,6 +481,7 @@ class FrameClient {
       "SetStaticToken",
       "SetVisibility",
       "SetPermission",
+      "Shares",
       "SpaceNodes",
       "StartABRMezzanineJobs",
       "StreamAddWatermark",
@@ -495,6 +499,7 @@ class FrameClient {
       "UnlinkAccessGroupFromOauth",
       "UpdateContentObjectGraph",
       "UpdateNTPInstance",
+      "UpdateShare",
       "UploadFileData",
       "UploadFilesFromS3",
       "UploadJobStatus",

package/src/client/ABRPublishing.js

@@ -1,7 +1,7 @@
 /**
  * Methods for ABR video creation and management
  *
- * For more information on how to publish ABR content see <a href="./abr/index.html">this detailed guide</a>
+ * For more information on how to publish ABR content see <a href="https://docs.eluv.io/docs/guides/media-ingest/">this detailed guide</a>
  *
  * @module ElvClient/ABRPublishing
  */

package/src/client/ContentAccess.js

@@ -1454,7 +1454,7 @@ exports.PlayoutOptions = async function({
 
   try {
     // If public/asset_metadata/sources/<offering> exists, use that instead of directly calling on object
-    if(!linkPath) {
+    if(!linkPath && handler === "playout") {
       const offeringPath = UrlJoin("public", "asset_metadata", "sources", offering);
       const link = await this.ContentObjectMetadata({
         libraryId,
@@ -1573,6 +1573,7 @@ exports.PlayoutOptions = async function({
             signedLink ?
               await this.LinkUrl({
                 versionHash,
+                writeToken,
                 linkPath: UrlJoin(linkPath, offering, playoutPath),
                 queryParams,
                 noAuth: true
@@ -1581,6 +1582,7 @@ exports.PlayoutOptions = async function({
                 libraryId: linkTarget.libraryId || libraryId,
                 objectId: linkTarget.objectId || objectId,
                 versionHash: linkTarget.versionHash || versionHash,
+                writeToken,
                 rep: UrlJoin(handler, offering, playoutPath),
                 noAuth: true,
                 queryParams
@@ -2051,6 +2053,7 @@ exports.CallBitcodeMethod = async function({
  * @namedParams
  * @param {string=} libraryId - ID of the library
  * @param {string=} objectId - ID of the object
+ * @param {string=} writeToken - A write token for a draft of the object (requires libraryId)
  * @param {string=} versionHash - Hash of the object version - if not specified, latest version will be used
  * @param {string} rep - Representation to use
  * @param {Object=} queryParams - Query params to add to the URL
@@ -2066,11 +2069,11 @@ exports.CallBitcodeMethod = async function({
  *
  * @returns {Promise<string>} - URL to the specified rep endpoint with authorization token
  */
-exports.Rep = async function({libraryId, objectId, versionHash, rep, queryParams={}, service="fabric", makeAccessRequest=false, channelAuth=false, noAuth=false, noCache=false}) {
+exports.Rep = async function({libraryId, objectId, versionHash, writeToken, rep, queryParams={}, service="fabric", makeAccessRequest=false, channelAuth=false, noAuth=false, noCache=false}) {
   ValidateParameters({libraryId, objectId, versionHash});
   if(!rep) { throw "Rep not specified"; }
 
-  return this.FabricUrl({libraryId, objectId, versionHash, rep, queryParams, service, makeAccessRequest, channelAuth, noAuth, noCache});
+  return this.FabricUrl({libraryId, objectId, versionHash, writeToken, rep, queryParams, service, makeAccessRequest, channelAuth, noAuth, noCache});
 };
 
 /**

package/src/client/Shares.js

@@ -0,0 +1,162 @@
+/**
+ * Methods for creating and managing shared authorization tokens
+ *
+ * @module ElvClient/Shares
+ */
+
+const UrlJoin = require("url-join");
+
+/**
+ * Create a share
+ *
+ * @namedParams
+ * @param {string} objectId - The object to create a share for
+ * @param {Date} expiresAt - The expiration time of the share
+ * @param {Object=} params - Additional parameters
+ *
+ * @returns {Promise<Object>} - Info about the created share
+ */
+exports.CreateShare = async function({objectId, expiresAt, params={}}) {
+  const tenantId = await this.userProfileClient.TenantContractId();
+
+  params.object_id = objectId;
+
+  if(expiresAt) {
+    params.end_time = Math.floor(new Date(expiresAt).getTime() / 1000);
+  }
+
+  return await this.MakeAuthServiceRequest({
+    path: UrlJoin("as", "sharing", tenantId, "share"),
+    method: "POST",
+    format: "JSON",
+    body: params,
+    headers: {
+      Authorization: `Bearer ${this.signedToken}`
+    }
+  });
+};
+
+/**
+ * List shares associated with your tenancy
+ *
+ * @namedParams
+ * @param {string=} objectId - If specified, the results will be limited shares for the specified object
+ * @param {number=} limit=100 - Maximum number of results to return
+ * @param {number=} offset=0 - Offset from which to return results
+ *
+ * @returns {Promise<Array<Object>>} - Info about the shares
+ */
+exports.Shares = async function({objectId, limit=100, offset=0}={}) {
+  const tenantId = await this.userProfileClient.TenantContractId();
+
+  const response = await this.MakeAuthServiceRequest({
+    path: UrlJoin("as", "sharing", tenantId, "shares"),
+    method: objectId ? "POST" : "GET",
+    queryParams: { limit, offset },
+    body: objectId ? {object_id: objectId} : undefined,
+    format: "JSON",
+    headers: {
+      Authorization: `Bearer ${this.signedToken}`
+    }
+  });
+
+  // Convert dates from seconds to date strings
+  if(response && response.shares) {
+    response.shares = response.shares.map(share => ({
+      ...share,
+      start_time: share.start_time ? new Date(share.start_time * 1000).toISOString() : null,
+      end_time: share.end_time ? new Date(share.end_time * 1000).toISOString() : null,
+    }));
+  }
+
+  return response;
+};
+
+/**
+ * Update the specified share
+ *
+ * @namedParams
+ * @param {string} shareId - The ID of the share to modify
+ * @param {Date=} expiresAt - The new expiration time of the share
+ * @param {Object=} params - Additional parameters
+ *
+ * @returns {Promise<Object>} - Info about the updated share
+ */
+exports.UpdateShare = async function({shareId, expiresAt, params={}}) {
+  const tenantId = await this.userProfileClient.TenantContractId();
+
+  if(expiresAt) {
+    params.end_time = Math.floor(new Date(expiresAt).getTime() / 1000);
+  }
+
+  return await this.MakeAuthServiceRequest({
+    path: UrlJoin("as", "sharing", tenantId, "share", shareId),
+    method: "PUT",
+    format: "JSON",
+    body: params,
+    headers: {
+      Authorization: `Bearer ${this.signedToken}`
+    }
+  });
+};
+
+/**
+ * Revoke the specified share
+ *
+ * @namedParams
+ * @param {string} shareId - The ID of the share to modify
+ */
+exports.RevokeShare = async function({shareId}) {
+  const tenantId = await this.userProfileClient.TenantContractId();
+
+  return await this.MakeAuthServiceRequest({
+    path: UrlJoin("as", "sharing", tenantId, "share", shareId, "revoke"),
+    method: "PUT",
+    format: "JSON",
+    headers: {
+      Authorization: `Bearer ${this.signedToken}`
+    }
+  });
+};
+
+/**
+ * Retrieve info about the specified share
+ *
+ * @namedParams
+ * @param {string} shareId - The ID of the share
+ *
+ * @returns {Promise<Object>} - Info about the share
+ */
+exports.ShareInfo = async function({shareId}) {
+  const {share} = await this.MakeAuthServiceRequest({
+    path: UrlJoin("as", "sharing", "share", shareId, "info"),
+    method: "GET",
+    format: "JSON"
+  });
+
+  if(share.start_time) {
+    share.start_time = new Date(share.start_time * 1000).toISOString();
+  }
+
+  if(share.end_time) {
+    share.end_time = new Date(share.end_time * 1000).toISOString();
+  }
+
+  return share;
+};
+
+/**
+ * Retrieve the authorization token for the specified share
+ *
+ * @namedParams
+ * @param {string} shareId - The ID of the share
+ *
+ * @returns {Promise<Object>} - The authorization token for the share
+ */
+exports.RedeemShareToken = async function({shareId}) {
+  return (await this.MakeAuthServiceRequest({
+    path: UrlJoin("as", "sharing", "share", shareId, "token"),
+    method: "GET",
+    format: "JSON"
+  })).token;
+};

package/utilities/GenerateFabricToken.js

@@ -2,7 +2,7 @@ const { ElvClient } = require("../src/ElvClient");
 
 const GenerateFabricToken = async () => {
   try {
-    const client = await ElvClient.FromNetworkName({networkName: "main"});
+    const client = await ElvClient.FromNetworkName({networkName: process.env.ENV ?? "main"});
 
     const wallet = client.GenerateWallet();
     const signer = wallet.AddAccount({
@@ -12,7 +12,8 @@ const GenerateFabricToken = async () => {
     client.SetSigner({signer});
 
     console.log(await client.CreateFabricToken({
-      duration: parseInt(process.env.DURATION),
+      duration: parseInt(process.env.DURATION ?? 24 * 60 * 60 * 1000),
+      context:  JSON.parse(process.env.ELV_TOK_CTX ?? "{}")
       //context: {email:"xyz@eluv.io"}
     }));
   } catch(error) {

package/build/BuildDocs.js

@@ -1,12 +0,0 @@
-const Showdown = require("showdown");
-const fs = require("fs");
-const Path = require("path");
-
-Showdown.setFlavor("vanilla");
-
-const markdownConverter = new Showdown.Converter();
-
-const md = fs.readFileSync(Path.join(__dirname, "..", "docs", "abr", "index.md")).toString("utf-8");
-const html = markdownConverter.makeHtml(md);
-
-fs.writeFileSync(Path.join(__dirname, "..", "docs", "abr", "index.html"), html);