@eluvio/elv-client-js 3.1.91 → 3.1.94

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eluvio/elv-client-js",
-  "version": "3.1.91",
+  "version": "3.1.94",
   "description": "Javascript client for the Eluvio Content Fabric",
   "main": "src/ElvClient.js",
   "author": "Kevin Talmadge",
@@ -57,6 +57,7 @@
   "dependencies": {
     "@babel/runtime": "^7.8.4",
     "@eluvio/crypto": ">=1.0.8",
+    "@eluvio/elv-abr-profile": "^0.2.0",
     "@sindresorhus/slugify": "^1.1.0",
     "babel-loader": "^8.0.6",
     "bignumber.js": "^8.0.2",

package/src/HttpClient.js

@@ -77,10 +77,10 @@ class HttpClient {
       headers: this.RequestHeaders(bodyType, headers)
     };
 
-    if(method === "POST" || method === "PUT") {
+    if(method === "POST" || method === "PUT" || method === "DELETE") {
       if(body && bodyType === "JSON") {
         fetchParameters.body = JSON.stringify(body);
-      } else {
+      } else if(body) {
         fetchParameters.body = body;
       }
     }

package/src/Utils.js

@@ -150,6 +150,125 @@ const Utils = {
     };
   },
 
+  /**
+   * Decode the specified write token into its component parts
+   *
+   * @param writeToken
+   *
+   * @returns {Object} - Components of the write token.
+   */
+  DecodeWriteToken: (writeToken) => {
+    /*
+    Format:
+    - content write token, LRO:
+      - prefix: "tq__", "tqw__", "tlro"
+      - format:
+        prefix + base58(uvarint(len(QID) | QID |
+                        uvarint(len(NID) | NID |
+                        uvarint(len(RAND_BYTES) | RAND_BYTES)
+    - content part write token:
+      - prefix: "tqp_"
+      - format:
+        prefix + base58(scheme | flags | uvarint(len(RAND_BYTES) | RAND_BYTES)
+    - content write token v1, content part write token v1:
+      - prefix: "tqw_", "tqpw"
+      - format:
+        prefix + base58(RAND_BYTES)
+     */
+
+    if(writeToken.length<4){
+      throw new Error(`Invalid write token: ["${writeToken}"] (unknown prefix)`);
+    }
+
+    let tokenType;
+
+    if(writeToken.startsWith("tqw__")) {
+      tokenType = "tq__";
+      writeToken = writeToken.slice(5);
+    } else {
+      tokenType = writeToken.slice(0, 4);
+      writeToken = writeToken.slice(4);
+    }
+    if(writeToken.length===0){
+      throw new Error(`Invalid write token: ["${writeToken}"] (too short)`);
+    }
+
+    switch(tokenType) {
+      case "tqw_":
+      case "tq__":
+      case "tqpw":
+      case "tqp_":
+      case "tlro":
+        break;
+      default:
+        throw new Error(`Invalid write token: ["${writeToken}"] (unknown prefix)`);
+    }
+
+    // decode base58 payload
+    let bytes = Utils.FromB58(writeToken);
+
+    function decodeBytes(isID, prefix) {
+      let bsize = VarInt.decode(bytes,0); // decode: count of bytes to read
+      let offset = VarInt.decode.bytes;   // offset in buffer to start read after decode
+      let theBytes;
+      let ret;
+
+      if(isID) {
+        theBytes = bytes.slice(offset+1, bsize+offset); // skip 1st byte (code id) at offset 0
+        if(theBytes.length===0){
+          ret = "";
+        } else {
+          ret = prefix + Utils.B58(theBytes);
+        }
+      } else {
+        theBytes = bytes.slice(offset, bsize+offset);
+        ret = "0x" + theBytes.toString("hex");
+      }
+      bytes = bytes.slice(bsize+offset);
+      return ret;
+    }
+
+    let tokenId;
+    let qid;
+    let nid;
+    let scheme;
+    let flags;
+
+    switch(tokenType) {
+      case "tqw_": // content write token v1
+      case "tqpw": // content part write token v1
+        tokenId = "0x" + bytes.toString("hex");
+        break;
+      case "tlro": // LRO,
+      case "tq__": // content write token
+        qid = decodeBytes(true, "iq__");
+        nid = decodeBytes(true, "inod");
+        tokenId = decodeBytes(false, "");
+        break;
+      case "tqp_": // content part write token
+        if(bytes.length<3) {
+          throw new Error(`Invalid write token: ["${writeToken}"] (token truncated)`);
+        }
+        scheme=bytes[0];
+        flags=bytes[1];
+        bytes = bytes.slice(2);
+        tokenId = decodeBytes(false, "");
+        break;
+      default:
+        // already raised
+        throw new Error(`Invalid write token: ["${writeToken}"] (unknown prefix)`);
+    }
+
+    return {
+      tokenType: tokenType,   // type of token
+      tokenId: tokenId,       // random bytes generated by the fabric node
+      objectId: qid,          // content id for content write token (tq__) or LRO (tlro)
+      nodeId: nid,            // node id where the content write token is valid (tq__)
+      scheme,                 // encryption scheme for part write token - (tqp_)
+      flags                   // flags for part write token (tqp_)
+    };
+  },
+
   /**
    * Convert contract address to multiformat hash
    *

package/src/client/ABRPublishing.js

@@ -478,7 +478,7 @@ exports.StartABRMezzanineJobs = async function({
     metadata: lroInfo
   });
 
-  await this.FinalizeContentObject({
+  const finalizeResponse = await this.FinalizeContentObject({
     libraryId,
     objectId,
     writeToken: statusDraft.write_token,
@@ -500,6 +500,7 @@ exports.StartABRMezzanineJobs = async function({
   });
 
   return {
+    hash: finalizeResponse.hash,
     lro_draft: lroInfo,
     writeToken: processingDraft.write_token,
     data,

package/src/client/NFT.js

@@ -18,9 +18,8 @@ const {
  * @methodGroup Minting
  * @namedParams
  * @param {string} tenantId - The ID of the tenant
- * @param {string=} email - The email of the NFT recipient
  * @param {string=} address - The address of the NFT recipient
- * @param {string} collectionId - The ID of the NFT collection containing the NFT
+ * @param {string} marketplaceId - The ID of the marketplace containing the NFT
  * @param {Array<Object>} items - List of items
  * @param {string} items.sku - SKU of the NFT
  * @param {number=} items.quantity=1 - Number to mint
@@ -30,66 +29,32 @@ const {
  *
  * @return Promise<Object> - An object containing the address for whom the NFT was minted and the transactionId of the minting request.
  */
-exports.MintNFT = async function({tenantId, email, address, collectionId, items, extraData={}}) {
+exports.MintNFT = async function({tenantId, address, marketplaceId, items, extraData={}}) {
   ValidatePresence("tenantId", tenantId);
-  ValidatePresence("email or address", email || address);
-  ValidatePresence("collectionId", collectionId);
+  ValidatePresence("address", address);
+  ValidatePresence("marketplaceId", marketplaceId);
   ValidatePresence("items", items);
 
-  ValidateObject(collectionId);
-
-  // If address not specified, make call to initialize address for email
-  let accountInitializationBody = { ts: Date.now() };
-  if(email) {
-    accountInitializationBody.email = email;
-  } else {
-    accountInitializationBody.addr = address;
-  }
-
-  const accountInitializationSignature = await this.Sign(
-    JSON.stringify(accountInitializationBody)
-  );
-
-  const {addr} = await this.utils.ResponseToJson(
-    await this.authClient.MakeAuthServiceRequest({
-      method: "POST",
-      path: `/as/tnt/prov/eth/${tenantId}`,
-      body: accountInitializationBody,
-      headers: {
-        "Authorization": `Bearer ${accountInitializationSignature}`
-      }
-    })
-  );
-
-  address = this.utils.FormatAddress(addr);
+  ValidateObject(marketplaceId);
+  ValidateAddress(address);
 
   let requestBody = {
-    "tickets": null,
-    "products": items.map(item => ({
+    tickets: null,
+    products: items.map(item => ({
       sku: item.sku,
       quant: item.quantity || 1,
       extra: item.tokenId ?
         { ...(item.extraData || {}), token_id: item.tokenId } :
         { ...(item.extraData || {}) }
     })),
-    "ident": email || address,
-    "cust_name": email || address,
-    "extra": {
-      ...extraData
+    ident: address,
+    cust_name: address,
+    extra: {
+      ...extraData,
+      elv_addr: address
     }
   };
 
-
-  ValidateAddress(address);
-
-  if(email) {
-    requestBody.email = email;
-  } else {
-    requestBody.addr = address;
-  }
-
-  requestBody.extra.elv_addr = address;
-
   const transactionId = this.utils.B58(UUID.parse(UUID.v4()));
   requestBody.ts = Date.now();
   requestBody.trans_id = transactionId;
@@ -100,7 +65,7 @@ exports.MintNFT = async function({tenantId, email, address, collectionId, items,
 
   await this.authClient.MakeAuthServiceRequest({
     method: "POST",
-    path: `/as/otp/webhook/base/${tenantId}/${collectionId}`,
+    path: UrlJoin("/as/tnt/trans/base", tenantId, marketplaceId),
     body: requestBody,
     headers: {
       "Authorization": `Bearer ${mintSignature}`

package/testScripts/VariantABRProfile.js

@@ -0,0 +1,45 @@
+/* eslint-disable no-console */
+
+
+const ScriptVariant = require("./parentClasses/ScriptVariant");
+const ABR = require("@eluvio/elv-abr-profile");
+
+class VariantABRProfile extends ScriptVariant {
+
+  async body() {
+    const client = await this.client();
+
+    const libraryId = this.args.libraryId;
+    const objectId = this.args.objectId;
+
+    // get media info from production master
+    const masterMetadata = await client.ContentObjectMetadata({
+      libraryId,
+      objectId,
+      metadataSubtree: "/production_master"
+    });
+
+    // adapt ABR Profile to production master's video properties
+    const generatedProfile = ABR.ABRProfileForVariant(
+      masterMetadata.sources,
+      masterMetadata.variants.default
+    );
+
+    if(!generatedProfile.ok) {
+      console.error("Error generating ABR Profile:\n" + generatedProfile.errors.join("\n"));
+    } else {
+      console.log(JSON.stringify(generatedProfile.result, null, 2));
+    }
+  }
+
+  header() {
+    return `Generate ABR Profile for production master ${this.args.objectId}, default variant`;
+  }
+
+  options() {
+    return super.options();
+  }
+}
+
+const script = new VariantABRProfile;
+script.run();

package/utilities/SimpleIngest.js

@@ -0,0 +1,245 @@
+// Create new production master from specified file(s)
+const R = require("ramda");
+
+const {ModOpt, NewOpt} = require("./lib/options");
+const Utility = require("./lib/Utility");
+
+const ABR = require("@eluvio/elv-abr-profile");
+
+const Client = require("./lib/concerns/Client");
+const Finalize = require("./lib/concerns/Finalize");
+const LocalFile = require("./lib/concerns/LocalFile");
+const LRO = require("./lib/concerns/LRO");
+const ArgLibraryId = require("./lib/concerns/ArgLibraryId");
+const {seconds} = require("./lib/helpers");
+
+class SimpleIngest extends Utility {
+  blueprint() {
+    return {
+      concerns: [Client, Finalize, LocalFile, ArgLibraryId, LRO],
+      options: [
+        ModOpt("libraryId", {demand: true, forX: "new media object"}),
+        NewOpt("title", {
+          demand: true,
+          descTemplate: "Title for new media object",
+          type: "string"
+        }),
+        NewOpt("drm", {
+          default: false,
+          descTemplate: "Use DRM for playback",
+          type: "boolean"
+        }),
+        ModOpt("files", {forX: "for new media object"})
+      ]
+    };
+  }
+
+  async body() {
+    const logger = this.logger;
+
+    let fileHandles = [];
+    const fileInfo = this.concerns.LocalFile.fileInfo(fileHandles);
+
+    // delay getting elvClient until this point so script exits faster
+    // if there is a validation error above
+    const client = await this.concerns.Client.get();
+
+    // get metadata from Library
+    const libInfo = await this.concerns.ArgLibraryId.libInfo();
+
+    const type = R.path(["metadata", "abr", "mez_content_type"], libInfo);
+    if(R.isNil(type)) throw Error("Library does not specify content type for simple ingests");
+
+    const libABRProfile = R.path(["metadata", "abr", "default_profile"], libInfo);
+    if(R.isNil(libABRProfile)) throw Error("Library does not specify ABR profile for simple ingests");
+
+    const {drm, libraryId, title} = this.args;
+    const encrypt = true;
+
+    logger.log("Uploading files...");
+
+    const createMasterResponse = await client.CreateProductionMaster({
+      libraryId,
+      type,
+      name: title,
+      description: `Media object created via simple ingest: ${title}`,
+      fileInfo,
+      encrypt,
+      copy: true,
+      callback: this.concerns.LocalFile.callback
+    });
+
+    const {id, hash} = createMasterResponse;
+    // Log object id immediately, in case of error later in script
+    // Don't log hash yet, it will change if --streams was provided (or any other revision to object is needed)
+    logger.data("object_id", id);
+
+    // Close file handles (if any)
+    this.concerns.LocalFile.closeFileHandles(fileHandles);
+
+    logger.errorsAndWarnings(createMasterResponse);
+
+    logger.logList(
+      "",
+      "Production master default variant created:",
+      `  Object ID: ${id}`,
+      `  Version Hash: ${hash}`,
+      ""
+    );
+
+    logger.data("version_hash", hash);
+
+    if(!R.isNil(createMasterResponse.errors) && !R.isEmpty(createMasterResponse.errors)) throw Error(`Error(s) encountered while inspecting uploaded files: ${createMasterResponse.errors.join("\n")}`);
+
+    await seconds(2);
+
+    await this.concerns.Finalize.waitForPublish({
+      latestHash: hash,
+      libraryId,
+      objectId: id
+    });
+
+
+    // get production master metadata
+    const masterMetadata = (await client.ContentObjectMetadata({
+      libraryId,
+      objectId: id,
+      versionHash: hash,
+      metadataSubtree: "/production_master"
+    }));
+
+    const sources = R.prop("sources", masterMetadata);
+    const variant = R.path(["variants", "default"], masterMetadata);
+
+    // add info on source files and variant to data if --json selected
+    if(this.args.json) {
+      logger.data("media_files", sources);
+      logger.data("variant_default", variant);
+    }
+
+    // generate ABR profile
+    const genProfileRetVal = ABR.ABRProfileForVariant(sources, variant, libABRProfile);
+    if(!genProfileRetVal.ok) throw Error(`Error(s) encountered while generating ABR profile: ${genProfileRetVal.errors.join("\n")}`);
+
+    // filter DRM/clear as needed
+    const filterProfileRetVal = drm ?
+      ABR.ProfileExcludeClear(genProfileRetVal.result) :
+      ABR.ProfileExcludeDRM(genProfileRetVal.result);
+    if(!filterProfileRetVal.ok) throw Error(`Error(s) encountered while setting playout formats: ${filterProfileRetVal.errors.join("\n")}`);
+
+    // set up mezzanine offering
+    logger.log("Setting up media file conversion...");
+    const createMezResponse = await client.CreateABRMezzanine({
+      name: title,
+      libraryId,
+      objectId: id,
+      type,
+      masterVersionHash: hash,
+      variant: "default",
+      offeringKey: "default",
+      abrProfile: filterProfileRetVal.result
+    });
+
+    logger.errorsAndWarnings(createMezResponse);
+    const createMezErrors = createMezResponse.errors;
+    if(!R.isNil(createMezErrors) && !R.isEmpty(createMezErrors)) throw Error(`Error(s) encountered while setting up media file conversion: ${createMezErrors.join("\n")}`);
+
+    await this.concerns.Finalize.waitForPublish({
+      latestHash: createMezResponse.hash,
+      libraryId,
+      objectId: id
+    });
+
+
+    logger.log("Starting conversion to streaming format...");
+
+    const startJobsResponse = await client.StartABRMezzanineJobs({
+      libraryId,
+      objectId: id,
+      offeringKey: "default"
+    });
+
+    logger.errorsAndWarnings(startJobsResponse);
+    const startJobsErrors = createMezResponse.errors;
+    if(!R.isNil(startJobsErrors) && !R.isEmpty(startJobsErrors)) throw Error(`Error(s) encountered while starting file conversion: ${startJobsErrors.join("\n")}`);
+
+    const lroWriteToken = R.path(["lro_draft", "write_token"], startJobsResponse);
+    const lroNode = R.path(["lro_draft", "node"], startJobsResponse);
+
+    logger.data("library_id", libraryId);
+    logger.data("object_id", id);
+    logger.data("offering_key", "default");
+    logger.data("write_token", lroWriteToken);
+    logger.data("write_node", lroNode);
+
+    logger.logList(
+      "",
+      `Library ID: ${libraryId}`,
+      `Object ID: ${id}`,
+      "Offering: default",
+      `Write Token: ${lroWriteToken}`,
+      `Write Node: ${lroNode}`,
+      ""
+    );
+
+    // wait for latest version hash to become visible (if publish not finished, then checking progress can fail
+    // as metadata /lro_draft_default will not be found)
+
+    await this.concerns.Finalize.waitForPublish({
+      latestHash: startJobsResponse.hash,
+      libraryId,
+      objectId: id
+    });
+
+    logger.log("Progress:");
+
+    const lro = this.concerns.LRO;
+    let done = false;
+    let lastStatus;
+    while(!done) {
+      const statusMap = await lro.status({libraryId, objectId: id}); // TODO: check how offering key is used, if at all
+      const statusSummary = lro.statusSummary(statusMap);
+      lastStatus = statusSummary.run_state;
+      if(lastStatus !== LRO.STATE_RUNNING) done = true;
+      logger.log(`run_state: ${lastStatus}`);
+      const eta = statusSummary.estimated_time_left_h_m_s;
+      if(eta) logger.log(`estimated time left: ${eta}`);
+      await seconds(15);
+    }
+
+    const finalizeAbrResponse = await client.FinalizeABRMezzanine({
+      libraryId,
+      objectId: id,
+      offeringKey: "default"
+    });
+    const latestHash = finalizeAbrResponse.hash;
+
+    logger.errorsAndWarnings(finalizeAbrResponse);
+    const finalizeErrors = finalizeAbrResponse.errors;
+    if(!R.isNil(finalizeErrors) && !R.isEmpty(finalizeErrors)) throw Error(`Error(s) encountered while finalizing object: ${finalizeErrors.join("\n")}`);
+
+    logger.logList(
+      "",
+      "Playable media object created:",
+      `  Object ID: ${id}`,
+      `  Version Hash: ${latestHash}`,
+      ""
+    );
+    logger.data("version_hash", latestHash);
+    await this.concerns.Finalize.waitForPublish({
+      latestHash,
+      libraryId,
+      objectId: id
+    });
+  }
+
+  header() {
+    return "Create playable media object via simple ingest";
+  }
+}
+
+if(require.main === module) {
+  Utility.cmdLineInvoke(SimpleIngest);
+} else {
+  module.exports = SimpleIngest;
+}