@eluvio/elv-client-js 4.0.77 → 4.0.79

package/package.json

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

package/src/FrameClient.js

@@ -387,6 +387,7 @@ class FrameClient {
       "DeleteMetadata",
       "DeleteNTPInstance",
       "DeletePart",
+      "DeleteWriteToken",
       "DeployContract",
       "Download",
       "DownloadEncrypted",
@@ -478,6 +479,7 @@ class FrameClient {
       "StreamCreate",
       "StreamInitialize",
       "StreamInsertion",
+      "StreamListUrls",
       "StreamStatus",
       "StreamStartOrStopOrReset",
       "StreamStopSession",

package/src/HttpClient.js

@@ -29,6 +29,12 @@ class HttpClient {
     this.draftURIs[writeToken] = new URI(nodeUrlStr);
   }
 
+  ClearWriteToken({writeToken}) {
+    if(Object.hasOwn(this.draftURIs, writeToken)) {
+      delete this.draftURIs[writeToken];
+    }
+  }
+
   RequestHeaders(bodyType, headers={}) {
     if(!headers.Accept) {
       headers["Accept"] = "application/json";

package/src/UserProfileClient.js

@@ -476,9 +476,11 @@ await client.userProfileClient.UserMetadata()
    */
   async TenantContractId() {
     if(!this.tenantContractId) {
-      this.tenantContractId = await this.UserMetadata({metadataSubtree: "tenantContractId"});
+      const {objectId} = await this.UserWalletObjectInfo();
+      this.tenantContractId = await this.client.TenantContractId({
+        contractAddress: this.client.utils.HashToAddress(objectId)
+      });
     }
-
     return this.tenantContractId;
   }
 
@@ -489,44 +491,13 @@ await client.userProfileClient.UserMetadata()
    *
    * @namedParams
    * @param {string} tenantContractId - The tenant contract ID in hash format
-   * @param {string} address - The group address to use in the hash if id is not provided
+   * @param {string} address - The tenant address to use in the hash if id is not provided
    */
-  async SetTenantContractId({tenantContractId, address}) {
-    if(tenantContractId && (!tenantContractId.startsWith("iten") || !Utils.ValidHash(tenantContractId))) {
-      throw Error(`Invalid tenant ID: ${tenantContractId}`);
-    }
-
-    if(address) {
-      if(!Utils.ValidAddress(address)) {
-        throw Error(`Invalid address: ${address}`);
-      }
-
-      tenantContractId = `iten${Utils.AddressToHash(address)}`;
-    }
+  async SetTenantContractId({tenantContractId}) {
+    const {objectId} = await this.UserWalletObjectInfo();
 
-    try {
-      const version = await this.client.AccessType({id: tenantContractId});
-
-      if(version !== this.client.authClient.ACCESS_TYPES.TENANT) {
-        throw Error("Invalid tenant ID: " + tenantContractId);
-      }
-    } catch(error) {
-      throw Error("Invalid tenant ID: " + tenantContractId);
-    }
-
-    const tenantAdminGroupAddress = await this.client.CallContractMethod({
-      contractAddress: address || Utils.HashToAddress(tenantContractId),
-      methodName: "groupsMapping",
-      methodArgs : ["tenant_admin", 0],
-      formatArguments: true,
-    });
-
-    await this.MergeUserMetadata({
-      metadata: {
-        tenantContractId,
-        tenantId: !tenantAdminGroupAddress ? undefined : `iten${Utils.AddressToHash(tenantAdminGroupAddress)}`
-      }
-    });
+    const tenantInfo = await this.client.SetTenantContractId({ objectId,tenantContractId });
+    this.tenantContractId = tenantInfo.tenantContractId;
   }
 
   /**

package/src/client/AccessGroups.js

@@ -241,9 +241,8 @@ exports.CreateAccessGroup = async function({name, description, metadata={}, visi
   this.Log(`Creating access group: ${name || ""} ${description || ""}`);
   let { contractAddress } = await this.authClient.CreateAccessGroup();
   contractAddress = this.utils.FormatAddress(contractAddress);
-
   const objectId = this.utils.AddressToObjectId(contractAddress);
-  const tenantId = await this.userProfileClient.TenantId();
+  const tenantContractId = await this.userProfileClient.TenantContractId();
 
   this.Log(`Access group: ${contractAddress} ${objectId}`);
 
@@ -262,27 +261,6 @@ exports.CreateAccessGroup = async function({name, description, metadata={}, visi
     ...metadata
   };
 
-  if(tenantId) {
-    let tenantAdminGroupAddress = this.utils.HashToAddress(tenantId);
-
-    await this.AddContentObjectGroupPermission({
-      objectId,
-      groupAddress: tenantAdminGroupAddress,
-      permission: "manage"
-    });
-
-    await this.ReplaceContractMetadata({
-      contractAddress,
-      metadataKey: "_tenantId",
-      metadata: tenantId
-    });
-
-    groupMetadata["tenantId"] = tenantId;
-  } else {
-    // eslint-disable-next-line no-console
-    console.warn("No tenant ID associated with current tenant.");
-  }
-
   await this.ReplaceMetadata({
     libraryId: this.contentSpaceLibraryId,
     objectId,
@@ -303,6 +281,23 @@ exports.CreateAccessGroup = async function({name, description, metadata={}, visi
     commitMessage: "Create access group"
   });
 
+  if(tenantContractId){
+    const tenantInfo = await this.SetTenantContractId({contractAddress, tenantContractId});
+
+    if(tenantInfo.tenantId) {
+      let tenantAdminGroupAddress = this.utils.HashToAddress(tenantInfo.tenantId);
+
+      await this.AddContentObjectGroupPermission({
+        objectId,
+        groupAddress: tenantAdminGroupAddress,
+        permission: "manage"
+      });
+    } else {
+      // eslint-disable-next-line no-console
+      console.warn("No tenant ID associated with current tenant.");
+    }
+  }
+
   return contractAddress;
 };
 
@@ -946,4 +941,4 @@ exports.UnlinkAccessGroupFromOauth = async function({groupAddress}) {
     methodName: "setOAuthEnabled",
     methodArgs: [false]
   });
-};
+};

package/src/client/ContentAccess.js

@@ -1275,7 +1275,7 @@ exports.PlayoutPathResolution = async function({
  * Retrieve available playout offerings for the specified content
  *
  * @methodGroup Media
- * @param {string=} objectId - Id of the content
+ * @param {string=} objectId - ID of the content
  * @param {string=} versionHash - Version hash of the content
  * @param {string=} writeToken - Write token for the content
  * @param {string=} linkPath - If playing from a link, the path to the link
@@ -2176,6 +2176,11 @@ const EmbedMediaTypes = {
   - `showTitle` - Shows the video title, which is set from the title option (if set) or the metadata
   - `title` - Sets the page title
   - `viewRecordKey` - Contains record key
+  - `useTicketCodes` - Use tickets authorization
+  - `tenantId` - Tenant ID, required for tickets authorization
+  - `ntpId` - NTP ID, required for tickets authorization
+  - `ticketCode` - Ticket code, optional with tickets authorization
+  - `ticketSubject` - Ticket subject, optional with tickets authorization
  *
  * @returns {Promise<string>} - Will return an embed URL
  */
@@ -2279,6 +2284,22 @@ exports.EmbedUrl = async function({
       case "viewRecordKey":
         embedUrl.searchParams.set("vrk", options.viewRecordKey);
         break;
+      case "useTicketCodes":
+        embedUrl.searchParams.set("ptk", "");
+        if (options.tenantId) {
+          embedUrl.searchParams.set("ten", options.tenantId);
+        }
+        if (options.ntpId) {
+          embedUrl.searchParams.set("ntp", options.ntpId);
+        }
+        if (options.ticketCode) {
+          embedUrl.searchParams.set("tk", Buffer.from(options.ticketCode).toString("base64"));
+
+        }
+        if (options.ticketSubject) {
+          embedUrl.searchParams.set("sbj", Buffer.from(options.ticketSubject).toString("base64"));
+        }
+        break;
     }
   }
 

package/src/client/ContentManagement.js

@@ -221,6 +221,12 @@ exports.CreateContentType = async function({name, metadata={}, bitcode}) {
     commitMessage: "Create content type"
   });
 
+  const tenantContractId = await this.userProfileClient.TenantContractId();
+  if(tenantContractId){
+    await this.SetTenantContractId({contractAddress, tenantContractId});
+    this.Log(`tenant_contract_id set for ${objectId}`);
+  }
+
   return objectId;
 };
 
@@ -255,7 +261,7 @@ exports.CreateContentLibrary = async function({
   imageName,
   metadata={},
   kmsId,
-  tenantId
+  tenantContractId
 }) {
   if(!kmsId) {
     kmsId = `ikms${this.utils.AddressToHash(await this.DefaultKMSAddress())}`;
@@ -266,27 +272,6 @@ exports.CreateContentLibrary = async function({
 
   const { contractAddress } = await this.authClient.CreateContentLibrary({kmsId});
 
-
-  // Set tenant ID on the library if the user is associated with a tenant
-  if(!tenantId) {
-    tenantId = await this.userProfileClient.TenantId();
-  }
-
-  if(tenantId) {
-    if(!this.utils.ValidHash(tenantId)) {
-      throw Error(`Invalid tenant ID: ${tenantId}`);
-    }
-
-    await this.CallContractMethod({
-      contractAddress,
-      methodName: "putMeta",
-      methodArgs: [
-        "_tenantId",
-        tenantId
-      ]
-    });
-  }
-
   metadata = {
     ...metadata,
     name,
@@ -333,6 +318,16 @@ exports.CreateContentLibrary = async function({
     });
   }
 
+  // Set tenant contract ID on the library if the user is associated with a tenant
+  if(!tenantContractId) {
+    tenantContractId = await this.userProfileClient.TenantContractId();
+  }
+
+  if(tenantContractId){
+    await this.SetTenantContractId({contractAddress, tenantContractId});
+    this.Log(`tenant_contract_id set for ${contractAddress}`);
+  }
+
   this.Log(`Library ${libraryId} created`);
 
   return libraryId;
@@ -1530,3 +1525,30 @@ exports.SetAuthPolicy = async function({objectId, policyId}) {
     metadata: { "elv:delegation-id": policyId }
   });
 };
+
+/**
+ * Delete the specified write token
+ *
+ * @methodGroup Content Objects
+ *
+ * @namedParams
+ * @param {string} writeToken - Write token to delete
+ * @param {string} libraryId - ID of the library
+ */
+exports.DeleteWriteToken = async function({writeToken, libraryId}) {
+  ValidateWriteToken(writeToken);
+  ValidateLibrary(libraryId);
+
+  let path = UrlJoin("qlibs", libraryId, "q", writeToken);
+
+  const authorizationHeader = await this.authClient.AuthorizationHeader({libraryId, update: true});
+
+  await this.HttpClient.Request({
+    headers: authorizationHeader,
+    method: "DELETE",
+    path: path,
+    allowFailover: false
+  });
+
+  await this.HttpClient.ClearWriteToken({writeToken});
+};

package/src/client/Contracts.js

@@ -10,8 +10,10 @@ const Ethers = require("ethers");
 const {
   ValidateAddress,
   ValidateParameters,
-  ValidatePresence
+  ValidatePresence,
+  ValidateObject, ValidateVersion
 } = require("../Validation");
+const Utils=require("../Utils");
 
 /**
  * Return the name of the contract, as specified in the contracts "version" string
@@ -323,12 +325,16 @@ exports.ReplaceContractMetadata = async function({contractAddress, metadataKey,
   ValidatePresence("contractAddress", contractAddress);
   ValidatePresence("metadataKey", metadataKey);
 
+  if(typeof metadata === "object") {
+    metadata = JSON.stringify(metadata);
+  }
+
   await this.CallContractMethodAndWait({
     contractAddress,
     methodName: "putMeta",
     methodArgs: [
       metadataKey,
-      JSON.stringify(metadata)
+      metadata
     ]
   });
 };
@@ -572,3 +578,152 @@ exports.SendFunds = async function({recipient, ether}) {
 
   return await transaction.wait();
 };
+
+/**
+ * Retrieve the ID of the tenant contract for the specified object
+ *
+ * @methodGroup Tenant
+ * @namedParams
+ * @param {string=} contractAddress - The address of the object
+ * @param {string=} objectId - The ID of the object
+ * @param {string=} versionHash - A version hash of the object
+ *
+ * @returns {Promise<string|undefined>}
+ */
+exports.TenantContractId = async function({contractAddress, objectId, versionHash}) {
+
+  if(contractAddress){
+    ValidateAddress(contractAddress);
+    objectId = Utils.AddressToObjectId(contractAddress);
+  } else if(versionHash){
+    ValidateVersion(versionHash);
+    objectId = this.utils.DecodeVersionHash(versionHash).objectId;
+    contractAddress = Utils.HashToAddress(objectId);
+  } else if(objectId){
+    ValidateObject(objectId);
+    contractAddress=Utils.HashToAddress(objectId);
+  } else {
+    throw Error("contractAddress or objectId or versionHash not specified");
+  }
+
+  const hasGetMetaMethod = await this.authClient.ContractHasMethod({
+    contractAddress: contractAddress,
+    methodName: "getMeta"
+  });
+
+  if(hasGetMetaMethod) {
+    const tenantContractId = await this.ContractMetadata({
+      contractAddress:contractAddress,
+      metadataKey:"_ELV_TENANT_ID"
+    });
+    if(tenantContractId !== "") {
+      return tenantContractId;
+    }
+  }
+
+  const libraryId = await this.ContentObjectLibraryId({ objectId });
+
+  return await this.ContentObjectMetadata({
+    libraryId,
+    objectId,
+    metadataSubtree: "tenantContractId",
+  });
+};
+
+/**
+ * Set the tenant contract ID for the specified object
+ *
+ * @methodGroup Tenant
+ * @namedParams
+ * @param {string=} contractAddress - The address of the object
+ * @param {string=} objectId - The ID of the object
+ * @param {string=} versionHash - A version hash of the object
+ * @param {string} tenantContractId - The tenant contract ID to set
+ *
+ * @returns {Promise<{tenantId: (undefined|string), tenantContractId}>}
+ */
+exports.SetTenantContractId = async function({contractAddress, objectId, versionHash, tenantContractId}) {
+
+  if(contractAddress){
+    ValidateAddress(contractAddress);
+    objectId = Utils.AddressToObjectId(contractAddress);
+  } else if(versionHash){
+    ValidateVersion(versionHash);
+    objectId = this.utils.DecodeVersionHash(versionHash).objectId;
+    contractAddress = Utils.HashToAddress(objectId);
+  } else if(objectId){
+    ValidateObject(objectId);
+    contractAddress=Utils.HashToAddress(objectId);
+  } else {
+    throw Error("contractAddress or objectId or versionHash not specified");
+  }
+  ValidateObject(tenantContractId);
+
+  if(tenantContractId && (!tenantContractId.startsWith("iten") || !Utils.ValidHash(tenantContractId))) {
+    throw Error(`Invalid tenant ID: ${tenantContractId}`);
+  }
+  const tenantAddress = Utils.HashToAddress(tenantContractId);
+
+  const version = await this.authClient.AccessType(tenantContractId);
+  if(version !== this.authClient.ACCESS_TYPES.TENANT) {
+    throw Error("Invalid tenant ID: " + tenantContractId);
+  }
+
+  // get tenant admin group
+  const tenantAdminGroupAddress = await this.CallContractMethod({
+    contractAddress: tenantAddress,
+    methodName: "groupsMapping",
+    methodArgs: ["tenant_admin", 0],
+    formatArguments: true,
+  });
+
+  const hasPutMetaMethod = await this.authClient.ContractHasMethod({
+    contractAddress: contractAddress,
+    methodName: "putMeta"
+  });
+
+  if(hasPutMetaMethod) {
+
+    await this.ReplaceContractMetadata({
+      contractAddress: contractAddress,
+      metadataKey: "_ELV_TENANT_ID",
+      metadata: tenantContractId
+    });
+
+    if(tenantAdminGroupAddress){
+      await this.ReplaceContractMetadata({
+        contractAddress: contractAddress,
+        metadataKey: "_tenantId",
+        metadata: `iten${Utils.AddressToHash(tenantAdminGroupAddress)}`
+      });
+    } else {
+      // eslint-disable-next-line no-console
+      console.warn("No tenant ID associated with current tenant.");
+    }
+  } else {
+    const libraryId = await this.ContentObjectLibraryId({ objectId });
+    const editRequest = await this.EditContentObject({libraryId, objectId});
+
+    await this.MergeMetadata({
+      libraryId,
+      objectId,
+      writeToken: editRequest.write_token,
+      metadata:  {
+        tenantContractId,
+        tenantId: !tenantAdminGroupAddress ? undefined : `iten${Utils.AddressToHash(tenantAdminGroupAddress)}`
+      },
+    });
+
+    await this.FinalizeContentObject({
+      libraryId,
+      objectId,
+      writeToken: editRequest.write_token,
+      commitMessage: "set tenant_contract_id"
+    });
+  }
+
+  return {
+    tenantContractId: tenantContractId,
+    tenantId: !tenantAdminGroupAddress ? undefined : `iten${Utils.AddressToHash(tenantAdminGroupAddress)}`
+  };
+};