@dolbyio/dolbyio-rest-apis-client
Version:
Node.JS wrapper for the Dolby OptiView REST APIs
354 lines (348 loc) • 20.4 kB
JavaScript
;
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.streamSummary = exports.streamDetails = exports.listStreams = exports.listStreamSummaries = exports.listAllStreams = exports.listAllStreamSummaries = void 0;
var _httpHelpers = require("./internal/httpHelpers");
var Urls = _interopRequireWildcard(require("../urls"));
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
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 _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
/**
* ## List Streams
*
* List all streams created within last hour with specific sorting and pagination.
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-recent-streams/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param options Options to sort the response.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link ListStreamsResponse} object.
*/
var listStreams = exports.listStreams = /*#__PURE__*/function () {
var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(apiSecret, options) {
var _options$sortBy, _options$page, _options$itemsOnPage, _options$isDescending;
var params, queryOptions;
return _regenerator().w(function (_context) {
while (1) switch (_context.n) {
case 0:
params = {
sortBy: (_options$sortBy = options.sortBy) !== null && _options$sortBy !== void 0 ? _options$sortBy : 'Live',
page: ((_options$page = options.page) !== null && _options$page !== void 0 ? _options$page : 1).toString(),
itemsOnPage: ((_options$itemsOnPage = options.itemsOnPage) !== null && _options$itemsOnPage !== void 0 ? _options$itemsOnPage : 10).toString(),
isDescending: ((_options$isDescending = options.isDescending) !== null && _options$isDescending !== void 0 ? _options$isDescending : false).toString()
};
if (options.isActive) {
params['isActive'] = options.isActive;
}
if (options.cluster) {
params['cluster'] = options.cluster.join(',');
}
if (options.isSecure) {
params['isSecure'] = options.isSecure;
}
if (options.isMultisource) {
params['isMultisource'] = options.isMultisource;
}
if (options.hasRedundant) {
params['hasRedundant'] = options.hasRedundant;
}
if (options.searchSubstring) {
params['searchSubstring'] = options.searchSubstring;
}
if (options.isRecordingAllowed) {
params['isRecordingAllowed'] = options.isRecordingAllowed;
}
if (options.isRestreaming) {
params['isRestreaming'] = options.isRestreaming;
}
if (options.transcoderId) {
params['transcoderId'] = options.transcoderId;
}
queryOptions = {
hostname: Urls.getRtsHostname(),
path: '/api/monitoring/streams',
params: params,
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context.n = 1;
return (0, _httpHelpers.sendGet)(queryOptions);
case 1:
return _context.a(2, _context.v);
}
}, _callee);
}));
return function listStreams(_x, _x2) {
return _ref.apply(this, arguments);
};
}();
/**
* ## List all Streams
*
* List all streams created within last hour with specific sorting and pagination.
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-recent-streams/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param options Options to sort the response.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link StreamDetails} object.
*/
var listAllStreams = exports.listAllStreams = /*#__PURE__*/function () {
var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(apiSecret, options) {
var result, page, listOptions, response;
return _regenerator().w(function (_context2) {
while (1) switch (_context2.n) {
case 0:
result = [];
page = 1;
case 1:
listOptions = _objectSpread(_objectSpread({}, options), {}, {
page: page,
itemsOnPage: 25
});
_context2.n = 2;
return listStreams(apiSecret, listOptions);
case 2:
response = _context2.v;
if (!(response.data.length === 0)) {
_context2.n = 3;
break;
}
return _context2.a(3, 5);
case 3:
result.push.apply(result, _toConsumableArray(response.data));
page++;
case 4:
if (true) {
_context2.n = 1;
break;
}
case 5:
return _context2.a(2, result);
}
}, _callee2);
}));
return function listAllStreams(_x3, _x4) {
return _ref2.apply(this, arguments);
};
}();
/**
* ## Stream Details
*
* Get stream details by stream name.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-get-stream/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param options Options to sort the response.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamDetails} object.
*/
var streamDetails = exports.streamDetails = /*#__PURE__*/function () {
var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(apiSecret, options) {
var queryOptions;
return _regenerator().w(function (_context3) {
while (1) switch (_context3.n) {
case 0:
queryOptions = {
hostname: Urls.getRtsHostname(),
path: "/api/monitoring/streams/".concat(options.streamName),
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context3.n = 1;
return (0, _httpHelpers.sendGet)(queryOptions);
case 1:
return _context3.a(2, _context3.v);
}
}, _callee3);
}));
return function streamDetails(_x5, _x6) {
return _ref3.apply(this, arguments);
};
}();
/**
* ## List Stream Summaries
*
* List a summary of all streams created within last hour with specific sorting and pagination.
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
* This is a lite version of {@link listStreams} which does not include feed details.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param options Options to sort the response.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link ListStreamSummariesResponse} object.
*/
var listStreamSummaries = exports.listStreamSummaries = /*#__PURE__*/function () {
var _ref4 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(apiSecret, options) {
var _options$sortBy2, _options$page2, _options$itemsOnPage2, _options$isDescending2;
var params, queryOptions;
return _regenerator().w(function (_context4) {
while (1) switch (_context4.n) {
case 0:
params = {
sortBy: (_options$sortBy2 = options.sortBy) !== null && _options$sortBy2 !== void 0 ? _options$sortBy2 : 'Live',
page: ((_options$page2 = options.page) !== null && _options$page2 !== void 0 ? _options$page2 : 1).toString(),
itemsOnPage: ((_options$itemsOnPage2 = options.itemsOnPage) !== null && _options$itemsOnPage2 !== void 0 ? _options$itemsOnPage2 : 10).toString(),
isDescending: ((_options$isDescending2 = options.isDescending) !== null && _options$isDescending2 !== void 0 ? _options$isDescending2 : false).toString()
};
if (options.isActive) {
params['isActive'] = options.isActive;
}
if (options.cluster) {
params['cluster'] = options.cluster.join(',');
}
if (options.isSecure) {
params['isSecure'] = options.isSecure;
}
if (options.isMultisource) {
params['isMultisource'] = options.isMultisource;
}
if (options.searchSubstring) {
params['searchSubstring'] = options.searchSubstring;
}
if (options.isRecordingAllowed) {
params['isRecordingAllowed'] = options.isRecordingAllowed;
}
if (options.transcoderId) {
params['transcoderId'] = options.transcoderId;
}
queryOptions = {
hostname: Urls.getRtsHostname(),
path: '/api/monitoring/summary',
params: params,
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context4.n = 1;
return (0, _httpHelpers.sendGet)(queryOptions);
case 1:
return _context4.a(2, _context4.v);
}
}, _callee4);
}));
return function listStreamSummaries(_x7, _x8) {
return _ref4.apply(this, arguments);
};
}();
/**
* ## List all Stream Summaries
*
* List a summary of all streams created within last hour with specific sorting and pagination.
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
* This is a lite version of {@link listAllStreams} which does not include feed details.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param options Options to sort the response.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link StreamSummary} object.
*/
var listAllStreamSummaries = exports.listAllStreamSummaries = /*#__PURE__*/function () {
var _ref5 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(apiSecret, options) {
var result, page, listOptions, response;
return _regenerator().w(function (_context5) {
while (1) switch (_context5.n) {
case 0:
result = [];
page = 1;
case 1:
listOptions = _objectSpread(_objectSpread({}, options), {}, {
page: page,
itemsOnPage: 25
});
_context5.n = 2;
return listStreamSummaries(apiSecret, listOptions);
case 2:
response = _context5.v;
if (!(response.data.length === 0)) {
_context5.n = 3;
break;
}
return _context5.a(3, 5);
case 3:
result.push.apply(result, _toConsumableArray(response.data));
page++;
case 4:
if (true) {
_context5.n = 1;
break;
}
case 5:
return _context5.a(2, result);
}
}, _callee5);
}));
return function listAllStreamSummaries(_x9, _x0) {
return _ref5.apply(this, arguments);
};
}();
/**
* ## Stream Summary
*
* Get stream summary by stream name.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-get-stream-summary/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param options Options to sort the response.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamSummary} object.
*/
var streamSummary = exports.streamSummary = /*#__PURE__*/function () {
var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, options) {
var queryOptions;
return _regenerator().w(function (_context6) {
while (1) switch (_context6.n) {
case 0:
queryOptions = {
hostname: Urls.getRtsHostname(),
path: "/api/monitoring/summary/".concat(options.streamName),
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context6.n = 1;
return (0, _httpHelpers.sendGet)(queryOptions);
case 1:
return _context6.a(2, _context6.v);
}
}, _callee6);
}));
return function streamSummary(_x1, _x10) {
return _ref6.apply(this, arguments);
};
}();