@eluvio/elv-client-js 4.0.4 → 4.0.6

package/utilities/NFTIngest.js

@@ -0,0 +1,527 @@
+// 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");
+var UrlJoin = require("url-join");
+const path = require("path");
+const fs = require("fs");
+const mime = require("mime-types");
+
+class NFTIngest 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("description", {
+          demand: false,
+          descTemplate: "Description for the new media object",
+          type: "string",
+        }),
+        NewOpt("nft_name", {
+          demand: false,
+          descTemplate: "The name attribute added to the .json file if exists.",
+          type: "string",
+        }),
+        NewOpt("nft_display_name", {
+          demand: false,
+          descTemplate: "The display_name attribute added to the .json file if exists. Default is the nft_name.",
+          type: "string",
+        }),
+        NewOpt("nft_description", {
+          demand: false,
+          descTemplate: "The description attribute added to the .json file if exists.",
+          type: "string",
+        }),
+        NewOpt("drm", {
+          default: false,
+          descTemplate: "Use DRM for playback",
+          type: "boolean",
+        }),
+        NewOpt("encrypt", {
+          default: false,
+          descTemplate: "Encrypt Content",
+          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();
+    const configUrl = client.NetworkInfo().configUrl;
+    logger.log("Network Info: ", client.NetworkInfo());
+    logger.log("Args: ", this.args);
+    // 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 libMezManageGroups = R.path(
+      ["metadata", "abr", "mez_manage_groups"],
+      libInfo
+    );
+
+    const libMezPermission = R.path(
+      ["metadata", "abr", "mez_permission_level"],
+      libInfo
+    );
+
+    const {drm, libraryId, title, description, encrypt, nft_name, nft_description} =
+      this.args;
+    
+    var {nft_display_name} = this.args;
+    
+    if(!nft_display_name) {
+      nft_display_name = nft_name;
+    }
+
+    logger.log("Uploading files...");
+
+    const createMasterResponse = await client.CreateProductionMaster({
+      libraryId,
+      type,
+      name: title,
+      description,
+      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",
+    });
+    let 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"
+        )}`
+      );
+    }
+
+    if(libMezManageGroups && libMezManageGroups.length > 0) {
+      for(const groupAddress of libMezManageGroups) {
+        logger.log("Setting access permissions for managers");
+        await client.AddContentObjectGroupPermission({
+          objectId: id,
+          groupAddress,
+          permission: "manage",
+        });
+      }
+    }
+
+    if(libMezPermission) {
+      if(
+        !["owner", "editable", "viewable", "listable", "public"].includes(
+          libMezPermission
+        )
+      ) {
+        logger.warn(
+          `Bad value for mez_permission_level: '${libMezPermission}', skipping permission setting`
+        );
+      } else {
+        logger.log(`Setting object permission to '${libMezPermission}'`);
+        const prevHash = await client.LatestVersionHash({ objectId: id });
+
+        await client.SetPermission({
+          objectId: id,
+          permission: libMezPermission,
+        });
+
+        const newHash = await client.LatestVersionHash({ objectId: id });
+
+        if(prevHash === newHash) {
+          logger.log("Version hash unchanged: " + newHash);
+        } else {
+          logger.log("Previous version hash: " + prevHash);
+          logger.log("New version hash: " + newHash);
+        }
+        logger.data("version_hash", newHash);
+        latestHash = newHash;
+      }
+    }
+
+    logger.logList(
+      "",
+      "Playable media object created:",
+      `  Object ID: ${id}`,
+      `  Version Hash: ${latestHash}`,
+      ""
+    );
+
+    await this.concerns.Finalize.waitForPublish({
+      latestHash,
+      libraryId,
+      objectId: id,
+    });
+
+    let filepath = path.parse(fileInfo[0].fullPath);
+    let imageLinkPath = "public/asset_metadata/images/img/default";
+    const imageExtensions = ["gif", "jpg", "jpeg", "png", "svg", "webp"];
+
+    for(const ext of imageExtensions) {
+      //Upload Image and set links if exists
+      let imageFile = path.join(filepath.dir, filepath.name) + "." + ext;
+      if(fs.existsSync(imageFile)) {
+        logger.log("Found image file: ", imageFile);
+        const fileDescriptor = fs.openSync(imageFile, "r");
+        const size = fs.fstatSync(fileDescriptor).size;
+        const mimeType = mime.lookup(imageFile) || `image/${ext}`;
+
+        let imageInfo = [
+          {
+            path: path.basename(imageFile),
+            type: "file",
+            mime_type: mimeType,
+            size: size,
+            data: fileDescriptor,
+          },
+        ];
+
+        await client.EditAndFinalizeContentObject({
+          libraryId,
+          objectId: id,
+          commitMessage: "Add Image file.",
+          callback: async ({ writeToken }) => {
+            try {
+              await client.UploadFiles({
+                libraryId,
+                objectId: id,
+                writeToken,
+                fileInfo: imageInfo,
+                callback: (progress) => {
+                  const fileProgress = progress[path.basename(imageFile)];
+                  let percentage = Math.round(
+                    (fileProgress.uploaded / fileProgress.total) * 100
+                  );
+
+                  logger.log(
+                    `Uploading ${path.basename(imageFile)}: ${percentage}%`
+                  );
+                },
+                encryption: encrypt ? "cgck" : "none",
+              });
+
+              await client.CreateLinks({
+                libraryId,
+                objectId: id,
+                writeToken,
+                links: [
+                  {
+                    target: `${path.basename(imageFile)}`,
+                    path: imageLinkPath,
+                    type: "file",
+                  },
+                ],
+              });
+
+              logger.log("Image uploaded and link created.");
+            } catch(err) {
+              logger.warn("Could not upload image file", err);
+            }
+          },
+        });
+
+        latestHash = await client.LatestVersionHash({ objectId: id });
+        break;
+      }
+    }
+
+    logger.data("Version Hash: ", latestHash);
+    let imageUrl = await client.FabricUrl({
+      versionHash: latestHash,
+      noAuth: true,
+    });
+
+    imageUrl = UrlJoin(
+      lroNode,
+      "s",
+      GetNetForPublic({ configUrl }),
+      "q",
+      latestHash,
+      "meta",
+      imageLinkPath
+    );
+
+    let embedUrl = CreateEmbedUrl({
+      versionHash: latestHash,
+      network: GetNetForEmbed({ configUrl }),
+    });
+
+    logger.logList(`embed_url: ${embedUrl}`, `image: ${imageUrl}`);
+
+    let jsonFile = path.join(filepath.dir, filepath.name) + ".json";
+    logger.log("Looking for Json file: ", jsonFile);
+
+    let jsonFileContents = null;
+
+    if(fs.existsSync(jsonFile)) {
+      try {
+        jsonFileContents = JSON.parse(fs.readFileSync(jsonFile));
+        logger.log("JSON File found: ", jsonFileContents);
+        if(nft_name) {
+          jsonFileContents.name = nft_name;
+        }
+        if(nft_display_name) {
+          jsonFileContents.display_name = nft_display_name;
+        }
+        if(nft_description) {
+          jsonFileContents.description = nft_description;
+        }
+        jsonFileContents.image = imageUrl;
+        jsonFileContents.embed_url = embedUrl;
+
+        let jsonString = JSON.stringify(jsonFileContents, "", 2);
+        fs.writeFileSync(jsonFile, jsonString);
+        logger.log("Json file updated: ", jsonString);
+        //file written successfully
+      } catch(err) {
+        logger.warn("Could not read or write to json file", err);
+      }
+    }
+  }
+
+  header() {
+    return "Ingest media for Generative Video NFTs";
+  }
+}
+
+const CreateEmbedUrl = ({ versionHash, network }) => {
+  return `https://embed.v3.contentfabric.io/?p&net=${network}&vid=${versionHash}&m&ap&lp&nwm`;
+};
+
+const GetNetForEmbed = ({ configUrl }) => {
+  if(configUrl.includes("demo")) {
+    return "demo";
+  } else if(configUrl.includes("test")) {
+    return "test";
+  } else {
+    return "main";
+  }
+};
+
+const GetNetForPublic = ({ configUrl }) => {
+  if(configUrl.includes("demo")) {
+    return "demov3";
+  } else if(configUrl.includes("test")) {
+    return "test";
+  } else {
+    return "main";
+  }
+};
+
+if(require.main === module) {
+  Utility.cmdLineInvoke(NFTIngest);
+} else {
+  module.exports = NFTIngest;
+}

package/utilities/lib/concerns/LocalFile.js

@@ -50,6 +50,7 @@ const New = context => {
       const mimeType = mime.lookup(fullPath) || "video/mp4";
 
       return {
+        fullPath,
         path: path.basename(fullPath),
         type: "file",
         mime_type: mimeType,
@@ -62,4 +63,4 @@ const New = context => {
   return {add, callback, closeFileHandles, fileInfo};
 };
 
-module.exports = {blueprint, New};
+module.exports = {blueprint, New};