@dolbyio/dolbyio-rest-apis-client 6.2.0 → 6.2.1

package/dist/index.js

@@ -34,4 +34,4 @@ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r
 // Expose the logger to control when/where to log
 
 /** Gets the version of this library. */
-var version = exports.version = "6.2.0";
+var version = exports.version = "6.2.1";

package/dist/internal/httpHelpers.js

@@ -44,6 +44,7 @@ var sendRequest = function sendRequest(options) {
     };
 
     // Override the User Agent
+    // @ts-ignore
     opts.headers['User-Agent'] = "DolbyIoRestApiSdk/".concat(_index.version, "; Node/").concat(process.versions.node);
     var req = _followRedirects.https.request(opts, function (res) {
       _jsLogger["default"].info("[".concat(opts.method, "] ").concat(res.statusCode, " - https://").concat(opts.hostname).concat(opts.path));
@@ -202,6 +203,7 @@ var download = exports.download = function download(filepath, options) {
     };
 
     // Override the User Agent
+    // @ts-ignore
     opts.headers['User-Agent'] = "DolbyIoRestApiSdk/".concat(_index.version, "; Node/").concat(process.versions.node);
     var req = _followRedirects.https.request(opts, function (res) {
       _jsLogger["default"].info("[".concat(opts.method, "] ").concat(res.statusCode, " - https://").concat(opts.hostname).concat(opts.path));

package/dist/streaming/assets.d.ts

@@ -59,7 +59,7 @@ export declare const list: (apiSecret: string, params: ListMediaAssetsQueryParam
 export declare const deleteAssets: (apiSecret: string, assetIds: string[]) => Promise<{
     id?: string;
     error?: string;
-}[]>;
+}[] | null>;
 /**
  * ## Read Media Asset
  *
@@ -88,7 +88,7 @@ export declare const read: (apiSecret: string, assetId: string) => Promise<Asset
 export declare const deleteAllAssets: (apiSecret: string, mediaAssetType: "recording" | "clip" | "storageValidation" | "timeline") => Promise<{
     id?: string;
     error?: string;
-}[]>;
+}[] | null>;
 /**
  * ## Generate Upload Credentials
  *

package/dist/streaming/mediaDistributions.d.ts

@@ -53,7 +53,7 @@ export declare const read: (apiSecret: string, mediaDistributionId: string) => P
 export declare const deleteMediaDistribution: (apiSecret: string, mediaDistributionId: string) => Promise<{
     id?: string;
     error?: string;
-}[]>;
+}[] | null>;
 /**
  * ## Updates Media Asset
  *
@@ -64,7 +64,7 @@ export declare const deleteMediaDistribution: (apiSecret: string, mediaDistribut
  * @param apiSecret The API Secret used to authenticate this request.
  * @param updateRequest The request body for creating a new media asset.
  *
- * @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link MediaDistribution} object.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link MediaDistribution} object.
  */
 export declare const updateMediaDistribution: (apiSecret: string, updateRequest: UpdateMediaDistributionRequest) => Promise<MediaDistribution>;
 /**
@@ -77,7 +77,7 @@ export declare const updateMediaDistribution: (apiSecret: string, updateRequest:
  * @param apiSecret The API Secret used to authenticate this request.
  * @param mediaDistributionId The ID of the media distribution to get the security keys from.
  *
- * @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link MediaDistribution} object.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
  */
 export declare const getSecurityKey: (apiSecret: string, mediaDistributionId: string) => Promise<SecurityKey[]>;
 /**
@@ -90,7 +90,7 @@ export declare const getSecurityKey: (apiSecret: string, mediaDistributionId: st
  * @param apiSecret The API Secret used to authenticate this request.
  * @param createRequest The request body for creating a new security key.
  *
- * @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link MediaDistribution} object.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
  */
 export declare const createSecurityKey: (apiSecret: string, createRequest: CreaseSecurityKeyRequest) => Promise<SecurityKey>;
 /**
@@ -109,4 +109,4 @@ export declare const createSecurityKey: (apiSecret: string, createRequest: Creas
 export declare const deleteSecurityKey: (apiSecret: string, mediaDistributionId: string, securityKeyId: string) => Promise<{
     status?: string;
     message?: string;
-}[]>;
+}[] | null>;

package/dist/streaming/mediaDistributions.js

@@ -180,7 +180,7 @@ var deleteMediaDistribution = exports.deleteMediaDistribution = /*#__PURE__*/fun
  * @param apiSecret The API Secret used to authenticate this request.
  * @param updateRequest The request body for creating a new media asset.
  *
- * @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link MediaDistribution} object.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link MediaDistribution} object.
  */
 var updateMediaDistribution = exports.updateMediaDistribution = /*#__PURE__*/function () {
   var _ref5 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(apiSecret, updateRequest) {
@@ -224,7 +224,7 @@ var updateMediaDistribution = exports.updateMediaDistribution = /*#__PURE__*/fun
  * @param apiSecret The API Secret used to authenticate this request.
  * @param mediaDistributionId The ID of the media distribution to get the security keys from.
  *
- * @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link MediaDistribution} object.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
  */
 var getSecurityKey = exports.getSecurityKey = /*#__PURE__*/function () {
   var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, mediaDistributionId) {
@@ -262,7 +262,7 @@ var getSecurityKey = exports.getSecurityKey = /*#__PURE__*/function () {
  * @param apiSecret The API Secret used to authenticate this request.
  * @param createRequest The request body for creating a new security key.
  *
- * @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link MediaDistribution} object.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
  */
 var createSecurityKey = exports.createSecurityKey = /*#__PURE__*/function () {
   var _ref7 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee7(apiSecret, createRequest) {

package/dist/streaming/monitoring.d.ts

@@ -1,4 +1,4 @@
-import { GetStreamDetailsOptions, ListAllStreamsSortOptions, ListStreamsResponse, ListStreamsSortOptions, StreamDetails } from './types/monitoring';
+import { GetStreamDetailsOptions, ListAllStreamsSortOptions, ListStreamsResponse, ListStreamsSortOptions, ListStreamSummariesResponse, ListStreamSummariesSortOptions, StreamDetails, StreamSummary } from './types/monitoring';
 /**
  * ## List Streams
  *
@@ -39,6 +39,51 @@ export declare const listAllStreams: (apiSecret: string, options: ListAllStreams
  * @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.
+ * @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamDetails} object.
  */
 export declare const streamDetails: (apiSecret: string, options: GetStreamDetailsOptions) => Promise<StreamDetails>;
+/**
+ * ## 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.
+ */
+export declare const listStreamSummaries: (apiSecret: string, options: ListStreamSummariesSortOptions) => Promise<ListStreamSummariesResponse>;
+/**
+ * ## 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.
+ */
+export declare const listAllStreamSummaries: (apiSecret: string, options: ListAllStreamsSortOptions) => Promise<StreamSummary[]>;
+/**
+ * ## 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.
+ */
+export declare const streamSummary: (apiSecret: string, options: GetStreamDetailsOptions) => Promise<StreamSummary>;

package/dist/streaming/monitoring.js

@@ -4,7 +4,7 @@ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" ==
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.streamDetails = exports.listStreams = exports.listAllStreams = void 0;
+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); }
@@ -162,7 +162,7 @@ var listAllStreams = exports.listAllStreams = /*#__PURE__*/function () {
  * @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.
+ * @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) {
@@ -188,4 +188,167 @@ var streamDetails = exports.streamDetails = /*#__PURE__*/function () {
   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);
+  };
 }();

package/dist/streaming/types/asset.d.ts

@@ -123,7 +123,7 @@ export interface AssetResponseData {
     /** Optional, ID of the object. */
     id?: string | null;
     /** Required, type of the object. */
-    type: 'recording' | 'clip' | 'storageValidation' | 'timeline' | 'feed';
+    type: 'recording' | 'clip' | 'storageValidation' | 'timeline' | 'vod';
     /** Optional, information about the asset. */
     feed?: MediaAssetFeedSelectionModel;
     /** Required, ISO 8601 date string, Start time of clip. */
@@ -148,6 +148,10 @@ export interface AssetResponseData {
     metadata?: RecordMetadata;
     /** Optional, asset download URL. */
     download?: RecordDownloadUrl;
+    /** Optional, Media distribution ID. */
+    mediaDistributionId?: string | null;
+    /** Optional, custom path for VOD content. */
+    customPath?: string | null;
 }
 /**
  * The allowable sort options for listing media assets.

package/dist/streaming/types/index.d.ts

@@ -2,6 +2,7 @@ export * from './account';
 export * from './asset';
 export * from './cluster';
 export * from './director';
+export * from './mediaDistributions';
 export * from './monitoring';
 export * from './publishToken';
 export * from './stream';

package/dist/streaming/types/index.js

@@ -47,6 +47,17 @@ Object.keys(_director).forEach(function (key) {
     }
   });
 });
+var _mediaDistributions = require("./mediaDistributions");
+Object.keys(_mediaDistributions).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _mediaDistributions[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _mediaDistributions[key];
+    }
+  });
+});
 var _monitoring = require("./monitoring");
 Object.keys(_monitoring).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/dist/streaming/types/monitoring.d.ts

@@ -12,8 +12,21 @@ export interface ListStreamsResponse {
     /** Array of stream details. */
     data: StreamDetails[];
 }
-/** Represents a stream details. */
-export interface StreamDetails {
+export interface ListStreamSummariesResponse {
+    /** Pagination object. */
+    pagination?: {
+        /** Total number of items. */
+        totalItems: number;
+        /** Total number of pages. */
+        totalPages: number;
+        /** Number of items in that page. */
+        itemsOnPage: number;
+    };
+    /** Array of stream details. */
+    data: StreamSummary[];
+}
+/** Represents a stream summary. */
+export interface StreamSummary {
     /** Identifier of the stream. */
     streamId: string;
     /** Name of the stream. */
@@ -36,6 +49,9 @@ export interface StreamDetails {
     endTime: string;
     /** Viewer count. */
     viewerCount: number;
+}
+/** Represents a stream details. */
+export interface StreamDetails extends StreamSummary {
     /** Has redundant stream. */
     hasRedundant: boolean;
     /** Restreaming enabled. */
@@ -170,7 +186,7 @@ export interface FeedStats {
     packetLoss: number;
 }
 /** Represents the options to sort the response for listing all the streams. */
-export interface ListAllStreamsSortOptions {
+export interface ListAllStreamSummariesSortOptions {
     /** How to sort the response. */
     sortBy: 'Live';
     /** Active streams. */
@@ -181,19 +197,25 @@ export interface ListAllStreamsSortOptions {
     isSecure?: boolean;
     /** Multi source streams. */
     isMultisource?: boolean;
-    /** Redundant streams. */
-    hasRedundant?: boolean;
     /** Filter the stream names. */
     searchSubstring?: string;
     /** Recorded allowed. */
     isRecordingAllowed?: boolean;
-    /** Restreaming streams. */
-    isRestreaming?: boolean;
     /** Identifier of the transcoder. */
     transcoderId?: string;
 }
+/** Represents the options to sort the response for listing all the streams. */
+export interface ListAllStreamsSortOptions extends ListAllStreamSummariesSortOptions {
+    /** Redundant streams. */
+    hasRedundant?: boolean;
+    /** Restreaming streams. */
+    isRestreaming?: boolean;
+}
+/** Represents the options to sort the response for listing streams. */
+export interface ListStreamSummariesSortOptions extends ListAllStreamsSortOptions, ListSortOptions<'Live'> {
+}
 /** Represents the options to sort the response for listing streams. */
-export interface ListStreamsSortOptions extends ListAllStreamsSortOptions, ListSortOptions<'Live'> {
+export interface ListStreamsSortOptions extends ListStreamSummariesSortOptions {
 }
 /** Represents the options to query the stream details. */
 export interface GetStreamDetailsOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dolbyio/dolbyio-rest-apis-client",
-    "version": "6.2.0",
+    "version": "6.2.1",
     "description": "Node.JS wrapper for the Dolby OptiView REST APIs",
     "main": "dist/index.js",
     "scripts": {
@@ -45,16 +45,16 @@
         "@babel/preset-env": "^7.29.0",
         "@babel/preset-typescript": "^7.28.5",
         "@types/follow-redirects": "^1.14.4",
-        "@types/node": "^25.4.0",
+        "@types/node": "^25.6.2",
         "babel-plugin-inline-replace-variables": "^1.3.1",
         "npm-watch": "^0.13.0",
-        "prettier": "^3.8.1",
-        "typedoc": "^0.28.17",
+        "prettier": "^3.8.3",
+        "typedoc": "^0.28.19",
         "typedoc-plugin-mdn-links": "^5.1.1",
-        "typescript": "^5.9.3"
+        "typescript": "^6.0.3"
     },
     "dependencies": {
-        "follow-redirects": "^1.15.11",
+        "follow-redirects": "^1.16.0",
         "js-logger": "^1.6.1"
     }
 }