@dolbyio/dolbyio-rest-apis-client 3.5.1 → 3.5.2

package/README.md

@@ -116,9 +116,11 @@ console.log(subscribeToken);
 
 ## Media Examples
 
-### Start an enhance job
+Here is an example on how to upload a file to the Dolby.io temporary cloud storage, enhance that file and download the result.
+
+### Get an API token
 
-To start an enhance job, use the following code:
+Get the App Key and Secret from the Dolby.io dashboard and use the following code in your python script.
 
 ```javascript
 const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
@@ -128,18 +130,72 @@ const APP_SECRET = 'YOUR_APP_SECRET';
 
 // Request an Access Token
 const jwt = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET);
+console.log('Access token', jwt);
+```
+
+### Upload a file for processing
+
+Upload a media file to the Dolby.io temporary cloud storage for processing:
+
+```javascript
+// Temporary storage URL that will be used as reference for the job processing
+const inputUrl = 'dlb://in/file.mp4';
+// Local path of the file to upload
+const originalFilePath = '/path/to/original_file.mp4';
+
+await dolbyio.io.uploadFile(jwt, inputUrl, originalFilePath);
+```
+
+### Start an enhance job
+
+Generate a job description and send it to Dolby.io.
+
+```javascript
+// Temporary storage URL that will be used as reference for the job processing
+const outputUrl = 'dlb://out/file.mp4';
 
 const jobDescription = JSON.stringify({
     content: { type: 'podcast' },
-    input: 'dlb://in/file.mp4',
-    output: 'dlb://out/file.mp4',
+    input: inputUrl,
+    output: outputUrl,
 });
 
 const jobId = await dolbyio.media.enhance.start(jwt, jobDescription);
-
 console.log(`Job ID: ${jobId}`);
 ```
 
+### Wait for the job to complete
+
+Get the job status and wait until it is completed.
+
+```javascript
+const sleep = (delay) => new Promise((r) => setTimeout(r, delay));
+
+let result = await dolbyio.media.enhance.getResults(jwt, jobId);
+while (result.status === 'Pending' || result.status === 'Running') {
+    console.log(`Job status is ${result.status}, taking a 5 second break...`);
+    await sleep(5000);
+
+    result = await dolbyio.media.enhance.getResults(jwt, jobId);
+}
+
+if (result.status !== 'Success') {
+    console.error('There was a problem with processing the file', result);
+    return;
+}
+```
+
+### Download a processed file
+
+At this stage, the file has been processed and written to the temporary storage so we can download it.
+
+```javascript
+// Local path where to download the file to
+const enhancedFilePath = '/path/to/enhanced_file.mp4';
+
+await dolbyio.io.downloadFile(jwt, outputUrl, enhancedFilePath);
+```
+
 ## Build this project
 
 To build the `dist` folder, run the command:

package/dist/index.js

@@ -15,5 +15,5 @@ var streaming = _interopRequireWildcard(require("./streaming"));
 exports.streaming = streaming;
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-var version = "3.5.1";
+var version = "3.5.2";
 exports.version = version;

package/dist/internal/httpHelpers.d.ts

@@ -55,3 +55,10 @@ export declare const sendPatch: (options: RequestOptions) => Promise<any>;
  * @param options Request options.
  */
 export declare const download: (filepath: string, options: RequestOptions) => Promise<void>;
+/**
+ * Upload a file.
+ *
+ * @param filepath The local path of the file to upload.
+ * @param uploadUrl Where to upload the file to.
+ */
+export declare const upload: (filepath: string, uploadUrl: string) => Promise<void>;

package/dist/internal/httpHelpers.js

@@ -3,9 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sendPut = exports.sendPost = exports.sendPatch = exports.sendGet = exports.sendDelete = exports.download = void 0;
+exports.upload = exports.sendPut = exports.sendPost = exports.sendPatch = exports.sendGet = exports.sendDelete = exports.download = void 0;
 var _fs = _interopRequireDefault(require("fs"));
 var _followRedirects = require("follow-redirects");
+var _https = _interopRequireDefault(require("https"));
 var _url = require("url");
 var _index = require("../index");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -250,4 +251,39 @@ var download = function download(filepath, options) {
     req.end();
   });
 };
-exports.download = download;
+
+/**
+ * Upload a file.
+ *
+ * @param filepath The local path of the file to upload.
+ * @param uploadUrl Where to upload the file to.
+ */
+exports.download = download;
+var upload = function upload(filepath, uploadUrl) {
+  // Get the size of the file to upload
+  var fileSize = _fs["default"].statSync(filepath).size;
+  return new Promise(function (resolve, reject) {
+    var opts = {
+      method: 'PUT',
+      headers: {
+        "Content-Length": fileSize
+      }
+    };
+    var req = _https["default"].request(uploadUrl, opts, function (res) {
+      console.log("[".concat(opts.method, "] ").concat(res.statusCode, " - ").concat(uploadUrl));
+      if (res.statusCode < 200 || res.statusCode >= 400) {
+        reject('This request has been rejected with the response code ' + res.statusCode);
+      } else {
+        resolve();
+      }
+    });
+    req.on('error', function (error) {
+      console.error(error);
+      reject(error);
+    });
+
+    // Start the upload of the file
+    _fs["default"].createReadStream(filepath).pipe(req);
+  });
+};
+exports.upload = upload;

package/dist/media/io.d.ts

@@ -31,6 +31,18 @@ export declare const getUploadUrl: (accessToken: JwtToken, dlbUrl: string) => Pr
  * @returns The download URL through a {@link Promise}.
  */
 export declare const getDownloadUrl: (accessToken: JwtToken, dlbUrl: string) => Promise<string | null>;
+/**
+ * Upload a media file to the Dolby.io temporary storage.
+ *
+ * The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-input-post
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ * @param filePath Local path of the file you want to upload.
+ */
+export declare const uploadFile: (accessToken: JwtToken, dlbUrl: string, filePath: string) => Promise<void>;
 /**
  * Download a media file.
  *

package/dist/media/io.js

@@ -4,7 +4,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getUploadUrl = exports.getDownloadUrl = exports.downloadFile = void 0;
+exports.uploadFile = exports.getUploadUrl = exports.getDownloadUrl = exports.downloadFile = void 0;
 var _httpHelpers = require("./internal/httpHelpers");
 var _httpHelpers2 = require("../internal/httpHelpers");
 var _urls = require("./internal/urls");
@@ -129,6 +129,42 @@ var getDownloadUrl = /*#__PURE__*/function () {
   };
 }();
 
+/**
+ * Upload a media file to the Dolby.io temporary storage.
+ *
+ * The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-input-post
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ * @param filePath Local path of the file you want to upload.
+ */
+exports.getDownloadUrl = getDownloadUrl;
+var uploadFile = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(accessToken, dlbUrl, filePath) {
+    var uploadUrl;
+    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+      while (1) {
+        switch (_context4.prev = _context4.next) {
+          case 0:
+            _context4.next = 2;
+            return getUploadUrl(accessToken, dlbUrl);
+          case 2:
+            uploadUrl = _context4.sent;
+            return _context4.abrupt("return", (0, _httpHelpers2.upload)(filePath, uploadUrl));
+          case 4:
+          case "end":
+            return _context4.stop();
+        }
+      }
+    }, _callee4);
+  }));
+  return function uploadFile(_x8, _x9, _x10) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+
 /**
  * Download a media file.
  *
@@ -142,18 +178,18 @@ var getDownloadUrl = /*#__PURE__*/function () {
  * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
  * @param filePath Local file path where to download the file to.
  */
-exports.getDownloadUrl = getDownloadUrl;
+exports.uploadFile = uploadFile;
 var downloadFile = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(accessToken, dlbUrl, filePath) {
+  var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(accessToken, dlbUrl, filePath) {
     var downloadUrl, idx, requestOptions;
-    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+    return _regeneratorRuntime().wrap(function _callee5$(_context5) {
       while (1) {
-        switch (_context4.prev = _context4.next) {
+        switch (_context5.prev = _context5.next) {
           case 0:
-            _context4.next = 2;
+            _context5.next = 2;
             return getDownloadUrl(accessToken, dlbUrl);
           case 2:
-            downloadUrl = _context4.sent;
+            downloadUrl = _context5.sent;
             downloadUrl = downloadUrl.replace('https://', '');
             idx = downloadUrl.indexOf('/');
             requestOptions = {
@@ -161,16 +197,16 @@ var downloadFile = /*#__PURE__*/function () {
               path: downloadUrl.substring(idx + 1),
               headers: {}
             };
-            return _context4.abrupt("return", (0, _httpHelpers2.download)(filePath, requestOptions));
+            return _context5.abrupt("return", (0, _httpHelpers2.download)(filePath, requestOptions));
           case 7:
           case "end":
-            return _context4.stop();
+            return _context5.stop();
         }
       }
-    }, _callee4);
+    }, _callee5);
   }));
-  return function downloadFile(_x8, _x9, _x10) {
-    return _ref4.apply(this, arguments);
+  return function downloadFile(_x11, _x12, _x13) {
+    return _ref5.apply(this, arguments);
   };
 }();
 exports.downloadFile = downloadFile;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dolbyio/dolbyio-rest-apis-client",
-    "version": "3.5.1",
+    "version": "3.5.2",
     "description": "Node.JS wrapper for the dolby.io REST APIs",
     "main": "dist/index.js",
     "scripts": {
@@ -13,6 +13,15 @@
     },
     "author": "Fabien Lavocat <fabien.lavocat@dolby.com>",
     "license": "MIT",
+    "keywords": [
+        "nodejs",
+        "api",
+        "sdk",
+        "rest",
+        "rest-api",
+        "webrtc",
+        "dolbyio"
+    ],
     "files": [
         "dist/*",
         "README.md"