merged 'ed/spaces'

Squashed commit of the following:

commit b7c333e4454f6f4dce2daf87f76e42f3a1662045
Author: Ed Ropple <[email protected]>
Date:   Thu May 19 15:47:39 2022 -0400

    mapped to pc/spaces

Author: eropple

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mux/mux-node",
-  "version": "5.0.0-rc.5",
+  "version": "5.0.0",
   "description": "Mux API wrapper",
   "keywords": [
     "mux",

src/video/domain.ts

@@ -337,3 +337,73 @@ export interface PlaybackRestrictionResponse {
 export interface ListPlaybackRestrictionsResponse {
   data: Array<PlaybackRestriction>;
 }
+
+export type SpaceStatus = 'idle' | 'active';
+export type BroadcastStatus = 'idle' | 'active';
+export type BroadcastLayout = 'gallery' | 'active-speaker';
+export type BroadcastResolution =
+  | '1920x1080'
+  | '1280x720'
+  | '1080x1920'
+  | '720x1280'
+  | '1080x1080'
+  | '720x720';
+
+export interface Broadcast {
+  id: string;
+  live_stream_id: string;
+  status: BroadcastStatus;
+  layout: BroadcastLayout;
+  resolution: BroadcastResolution;
+
+  passthrough?: string;
+  background?: string;
+}
+
+export interface Space {
+  id: string;
+  created_at: string;
+  type: 'server';
+  status: SpaceStatus;
+  passthrough?: string;
+  broadcasts?: Array<Broadcast>;
+}
+
+export interface CreateBroadcastRequest {
+  live_stream_id: string;
+
+  passthrough?: string;
+  layout?: BroadcastLayout;
+  resolution?: BroadcastResolution;
+}
+
+export interface CreateSpaceRequest {
+  type?: 'server';
+  passthrough?: string;
+  broadcasts?: Array<CreateBroadcastRequest>;
+}
+
+export interface SpaceResponse {
+  data: Space;
+}
+
+export interface BroadcastResponse {
+  data: Broadcast;
+}
+
+export interface ListSpacesRequest {
+  limit?: number;
+  page?: number;
+}
+
+export interface ListSpacesResponse {
+  data: Array<Space>;
+}
+
+export interface StartSpaceBroadcastResponse {
+  data: {};
+}
+
+export interface StopSpaceBroadcastResponse {
+  data: {};
+}

src/video/resources/spaces.ts

@@ -0,0 +1,88 @@
+import { Base } from '../../base.js';
+import { RequestOptions } from '../../RequestOptions.js';
+import {
+  BroadcastResponse,
+  CreateBroadcastRequest,
+  CreateSpaceRequest,
+  ListSpacesRequest,
+  ListSpacesResponse,
+  SpaceResponse,
+  StartSpaceBroadcastResponse,
+  StopSpaceBroadcastResponse,
+} from '../domain.js';
+
+const BASE_PATH = '/video/v1/spaces';
+
+const SPACE_PATH = (spaceId: string) => `${BASE_PATH}/${spaceId}`;
+const BROADCAST_PATH = (spaceId: string, broadcastId: string) =>
+  `${SPACE_PATH(spaceId)}/broadcasts/${broadcastId}`;
+
+export class Broadcasts extends Base {
+  create(
+    spaceId: string,
+    request: CreateBroadcastRequest
+  ): Promise<BroadcastResponse> {
+    return this.http.post(`${SPACE_PATH(spaceId)}/broadcasts`, request);
+  }
+
+  get(spaceId: string, broadcastId: string): Promise<BroadcastResponse> {
+    return this.http.get(BROADCAST_PATH(spaceId, broadcastId));
+  }
+
+  delete(spaceId: string, broadcastId: string): Promise<BroadcastResponse> {
+    return this.http.delete(BROADCAST_PATH(spaceId, broadcastId));
+  }
+
+  start(
+    spaceId: string,
+    broadcastId: string
+  ): Promise<StartSpaceBroadcastResponse> {
+    return this.http.post(`${BROADCAST_PATH(spaceId, broadcastId)}/start`);
+  }
+
+  stop(
+    spaceId: string,
+    broadcastId: string
+  ): Promise<StopSpaceBroadcastResponse> {
+    return this.http.post(`${BROADCAST_PATH(spaceId, broadcastId)}/stop`);
+  }
+}
+
+export class Spaces extends Base {
+  readonly Broadcasts: Broadcasts;
+
+  constructor(base: Base);
+  constructor(config: RequestOptions);
+  constructor(accessToken: string, secret: string, config: RequestOptions);
+  constructor(
+    accessTokenOrConfigOrBase: string | RequestOptions | Base,
+    secret?: string,
+    config?: RequestOptions
+  ) {
+    if (accessTokenOrConfigOrBase instanceof Base) {
+      super(accessTokenOrConfigOrBase);
+    } else if (typeof accessTokenOrConfigOrBase === 'object') {
+      super(accessTokenOrConfigOrBase);
+    } else {
+      super(accessTokenOrConfigOrBase, secret!, config!);
+    }
+
+    this.Broadcasts = new Broadcasts(this);
+  }
+
+  create(req: CreateSpaceRequest): Promise<SpaceResponse> {
+    return this.http.post(BASE_PATH, req);
+  }
+
+  list(params: ListSpacesRequest): Promise<ListSpacesResponse> {
+    return this.http.get(BASE_PATH, { params });
+  }
+
+  get(spaceId: string): Promise<SpaceResponse> {
+    return this.http.get(SPACE_PATH(spaceId));
+  }
+
+  delete(spaceId: string): Promise<SpaceResponse> {
+    return this.http.delete(SPACE_PATH(spaceId));
+  }
+}

src/video/video.ts

@@ -13,6 +13,7 @@ import { Uploads } from './resources/uploads.js';
 import { SigningKeys } from './resources/signingKeys.js';
 import { DeliveryUsage } from './resources/deliveryUsage.js';
 import { PlaybackRestrictions } from './resources/playbackRestrictions.js';
+import { Spaces } from './resources/spaces.js';
 
 /**
  * @ignore
@@ -37,6 +38,7 @@ export class Video extends Base {
   readonly Uploads: Uploads;
   readonly SigningKeys: SigningKeys;
   readonly DeliveryUsage: DeliveryUsage;
+  readonly Spaces: Spaces;
 
   constructor(base: Base);
   constructor(config: RequestOptions);
@@ -74,5 +76,8 @@ export class Video extends Base {
 
     /** @Type {PlaybackRestrictions} */
     this.PlaybackRestrictions = new PlaybackRestrictions(this);
+
+    /** @Type {Spaces} */
+    this.Spaces = new Spaces(this);
   }
 }