@dolbyio/dolbyio-rest-apis-client
Version:
Node.JS wrapper for the Dolby OptiView REST APIs
468 lines (457 loc) • 21.9 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.updateToken = exports.syncRestream = exports.listTokensByName = exports.listTokensByCluster = exports.listTokens = exports.getToken = exports.getAllActivePublishTokenId = exports.getActivePublishTokenId = exports.disableToken = exports.deleteToken = exports.createToken = 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 _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); }); }; }
/**
* Gets the specified publish token.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-read-token/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param tokenId Identifier of the publish token to read.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link PublishToken} object.
*/
var getToken = exports.getToken = /*#__PURE__*/function () {
var _ref = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(apiSecret, tokenId) {
var options;
return _regenerator().w(function (_context) {
while (1) switch (_context.n) {
case 0:
options = {
hostname: Urls.getRtsHostname(),
path: "/api/publish_token/".concat(tokenId),
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context.n = 1;
return (0, _httpHelpers.sendGet)(options);
case 1:
return _context.a(2, _context.v);
}
}, _callee);
}));
return function getToken(_x, _x2) {
return _ref.apply(this, arguments);
};
}();
/**
* ## Deletes the publish token
*
* Deletes token specified by the token's ID. The Token ID can be found using the {@link listTokens | List Tokens API} or in the API response of {@link createToken | Create Token API}.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-delete-token/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param tokenId Identifier of the publish token to delete.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a flag to indicate if the operation succeeded or not.
*/
var deleteToken = exports.deleteToken = /*#__PURE__*/function () {
var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(apiSecret, tokenId) {
var options;
return _regenerator().w(function (_context2) {
while (1) switch (_context2.n) {
case 0:
options = {
hostname: Urls.getRtsHostname(),
path: "/api/publish_token/".concat(tokenId),
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context2.n = 1;
return (0, _httpHelpers.sendDelete)(options);
case 1:
return _context2.a(2, _context2.v);
}
}, _callee2);
}));
return function deleteToken(_x3, _x4) {
return _ref2.apply(this, arguments);
};
}();
/**
* ## Updates the publish token
*
* Update token stream information as well as updates token itself.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-2-update-token/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param tokenId Identifier of the publish token to update.
* @param publishToken Settings of the publish token to update.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link PublishToken} object.
*/
var updateToken = exports.updateToken = /*#__PURE__*/function () {
var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(apiSecret, tokenId, publishToken) {
var options;
return _regenerator().w(function (_context3) {
while (1) switch (_context3.n) {
case 0:
options = {
hostname: Urls.getRtsHostname(),
path: "/api/v2/publish_token/".concat(tokenId),
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
Authorization: "Bearer ".concat(apiSecret)
},
body: JSON.stringify(publishToken)
};
_context3.n = 1;
return (0, _httpHelpers.sendPut)(options);
case 1:
return _context3.a(2, _context3.v);
}
}, _callee3);
}));
return function updateToken(_x5, _x6, _x7) {
return _ref3.apply(this, arguments);
};
}();
/**
* Lists all publish tokens with specific sorting and pagination.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-list-tokens/}
*
* @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 PublishToken} objects.
*/
var listTokens = exports.listTokens = /*#__PURE__*/function () {
var _ref4 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(apiSecret, options) {
var _options$isDescending;
var params, queryOptions;
return _regenerator().w(function (_context4) {
while (1) switch (_context4.n) {
case 0:
params = {
sortBy: options.sortBy,
page: options.page.toString(),
itemsOnPage: options.itemsOnPage.toString(),
isDescending: ((_options$isDescending = options.isDescending) !== null && _options$isDescending !== void 0 ? _options$isDescending : false).toString()
};
queryOptions = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/list',
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 listTokens(_x8, _x9) {
return _ref4.apply(this, arguments);
};
}();
/**
* ## List Publish Tokens By Name
*
* List all tokens with specific sorting and pagination that matches given token name or stream name.
* Tokens with wildcard stream names are excluded from the responses.
* If response array is empty, you have reached the end of the list ordering.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-list-tokens-by-name/}
*
* @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 PublishToken} objects.
*/
var listTokensByName = exports.listTokensByName = /*#__PURE__*/function () {
var _ref5 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(apiSecret, options) {
var _options$isDescending2;
var params, queryOptions;
return _regenerator().w(function (_context5) {
while (1) switch (_context5.n) {
case 0:
params = {
name: options.name,
sortBy: options.sortBy,
page: options.page.toString(),
itemsOnPage: options.itemsOnPage.toString(),
isDescending: ((_options$isDescending2 = options.isDescending) !== null && _options$isDescending2 !== void 0 ? _options$isDescending2 : false).toString()
};
if (options.filterBy) {
params['filterBy'] = options.filterBy;
}
queryOptions = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/list_by_name',
params: params,
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context5.n = 1;
return (0, _httpHelpers.sendGet)(queryOptions);
case 1:
return _context5.a(2, _context5.v);
}
}, _callee5);
}));
return function listTokensByName(_x0, _x1) {
return _ref5.apply(this, arguments);
};
}();
/**
* ## List Publish Tokens By Cluster
*
* List all tokens with specific sorting and pagination that matches given cluster region.
* If response array is empty, you have reached the end of the list ordering.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-list-tokens-by-cluster/}
*
* @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 PublishToken} objects.
*/
var listTokensByCluster = exports.listTokensByCluster = /*#__PURE__*/function () {
var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, options) {
var _options$isDescending3;
var params, queryOptions;
return _regenerator().w(function (_context6) {
while (1) switch (_context6.n) {
case 0:
params = {
cluster: options.cluster,
sortBy: options.sortBy,
page: options.page.toString(),
itemsOnPage: options.itemsOnPage.toString(),
isDescending: ((_options$isDescending3 = options.isDescending) !== null && _options$isDescending3 !== void 0 ? _options$isDescending3 : false).toString()
};
queryOptions = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/list_by_cluster',
params: params,
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 listTokensByCluster(_x10, _x11) {
return _ref6.apply(this, arguments);
};
}();
/**
* ## Creates a publish token
*
* Creates new token given a label and associated stream name(s).
* Stream names are limited to 128 characters.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-create-token/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param publishToken Information about the new publish token.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link PublishToken} object.
*/
var createToken = exports.createToken = /*#__PURE__*/function () {
var _ref7 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee7(apiSecret, publishToken) {
var options;
return _regenerator().w(function (_context7) {
while (1) switch (_context7.n) {
case 0:
options = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
Authorization: "Bearer ".concat(apiSecret)
},
body: JSON.stringify(publishToken)
};
_context7.n = 1;
return (0, _httpHelpers.sendPost)(options);
case 1:
return _context7.a(2, _context7.v);
}
}, _callee7);
}));
return function createToken(_x12, _x13) {
return _ref7.apply(this, arguments);
};
}();
/**
* Gets the Publish Token ID of an active stream by its Stream ID.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-get-active-token-by-stream-id/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param streamId Stream ID for which to get the publish token IDs.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link ActivePublishTokenResponse} object.
*/
var getActivePublishTokenId = exports.getActivePublishTokenId = /*#__PURE__*/function () {
var _ref8 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee8(apiSecret, streamId) {
var params, options;
return _regenerator().w(function (_context8) {
while (1) switch (_context8.n) {
case 0:
params = {
streamId: streamId
};
options = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/active',
params: params,
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context8.n = 1;
return (0, _httpHelpers.sendGet)(options);
case 1:
return _context8.a(2, _context8.v);
}
}, _callee8);
}));
return function getActivePublishTokenId(_x14, _x15) {
return _ref8.apply(this, arguments);
};
}();
/**
* Gets all Publish Token IDs for active streams on the account.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-get-all-active-tokens-by-account/}
*
* @param apiSecret The API Secret used to authenticate this request.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link ActivePublishTokenResponse} object.
*/
var getAllActivePublishTokenId = exports.getAllActivePublishTokenId = /*#__PURE__*/function () {
var _ref9 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee9(apiSecret) {
var options;
return _regenerator().w(function (_context9) {
while (1) switch (_context9.n) {
case 0:
options = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/active/all',
headers: {
Accept: 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context9.n = 1;
return (0, _httpHelpers.sendGet)(options);
case 1:
return _context9.a(2, _context9.v);
}
}, _callee9);
}));
return function getAllActivePublishTokenId(_x16) {
return _ref9.apply(this, arguments);
};
}();
/**
* Disables Publish Token(s) by their Token ID. An array of Token IDs can be used for bulk disable.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-disable-tokens/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param tokenIds List of token IDs to disable.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link DisablePublishTokenResponse} object.
*/
var disableToken = exports.disableToken = /*#__PURE__*/function () {
var _ref0 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee0(apiSecret, tokenIds) {
var body, options;
return _regenerator().w(function (_context0) {
while (1) switch (_context0.n) {
case 0:
body = {
tokenIds: tokenIds
};
options = {
hostname: Urls.getRtsHostname(),
path: '/api/publish_token/disable',
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
Authorization: "Bearer ".concat(apiSecret)
},
body: JSON.stringify(body)
};
_context0.n = 1;
return (0, _httpHelpers.sendPatch)(options);
case 1:
return _context0.a(2, _context0.v);
}
}, _callee0);
}));
return function disableToken(_x17, _x18) {
return _ref0.apply(this, arguments);
};
}();
/**
* ## Sync restreams
*
* Apply any re-stream configuration changes for running streams immediately.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/publish-token-v-1-sync-restream/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param tokenId Identifier of the publish token to sync.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a flag to indicate if the operation succeeded or not.
*/
var syncRestream = exports.syncRestream = /*#__PURE__*/function () {
var _ref1 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee1(apiSecret, tokenId) {
var options;
return _regenerator().w(function (_context1) {
while (1) switch (_context1.n) {
case 0:
options = {
hostname: Urls.getRtsHostname(),
path: "/api/publish_token/".concat(tokenId, "/restream/sync"),
headers: {
Accept: 'application/json',
'Content-Type': 'application/json',
Authorization: "Bearer ".concat(apiSecret)
}
};
_context1.n = 1;
return (0, _httpHelpers.sendPost)(options);
case 1:
return _context1.a(2, _context1.v);
}
}, _callee1);
}));
return function syncRestream(_x19, _x20) {
return _ref1.apply(this, arguments);
};
}();