TypeScript types

Hey, looking forward to using Mux in my project. It would be great if TypeScript typings could either be provided with the module, or in an @types/@mux/mux-node package. You’ve done a great job with the JSDoc comments, hopefully there’s an easy way to generate them from those.

[ebeloded]

Here are some types I wrote to have some typing support in our project. Maybe this will be helpful:

type MuxUpdateUploadEventType =
  | 'video.upload.asset_created'
  | 'video.upload.created'
  | 'video.upload.cancelled'
  | 'video.upload.errored'
type MuxUpdateAssetEventType =
  | 'video.asset.created'
  | 'video.asset.ready'
  | 'video.asset.errored'
  | 'video.asset.deleted'
type MuxUpdateStaticAssetEventType = 'video.asset.static_renditions.ready'

interface VideoTrack {
  type: 'video'
  max_width: number
  max_height: number
  max_frame_rate: number
  id: string
  duration: number
}

interface AudioTrack {
  type: 'audio'
  max_channels: 2
  max_channel_layout: 'stereo'
  id: string
  duration: number
}
interface MuxUpdateData {
  id: string
}
interface MuxUploadUpdateData extends MuxUpdateData {
  new_asset_settings: {
    playback_policies: ['public']
    mp4_support: 'standard'
    passthrough?: string
  }
  status: 'waiting' | 'asset_created'
  url: string
  cors_origin: string
  timeout: number
}
interface MuxAssetUpdateDataShared extends MuxUpdateData {
  created_at: number
  mp4_support: 'standard' | 'none'
  master_access: 'none'
  passthrough: string
  playback_ids: Array<{ policy: 'public'; id: string }>
}
interface MuxAssetUpdateDataPreparing extends MuxAssetUpdateDataShared {
  status: 'preparing'
}
interface MuxAssetUpdateDataReady extends MuxAssetUpdateDataShared {
  status: 'ready'
  tracks: Array<VideoTrack | AudioTrack>
  duration: number
  aspect_ratio: string //'16:9'
  max_stored_resolution: 'HD' | 'SD'
  max_stored_frame_rate: number
}
type MuxAssetUpdateData = MuxAssetUpdateDataReady | MuxAssetUpdateDataPreparing

interface MuxUpdateShared {
  request_id: null
  id: string
  environment: {
    name: string
    id: string
  }
  created_at: string
  accessor_source: null
  accessor: null
  attempts: []
}

interface MuxUploadUpdate extends MuxUpdateShared {
  type: MuxUpdateUploadEventType
  object: {
    type: 'upload'
    id: string
  }
  data: MuxUploadUpdateData
}
interface MuxAssetUpdate extends MuxUpdateShared {
  type: MuxUpdateAssetEventType
  object: {
    type: 'asset'
    id: string
  }
  data: Asset
}

interface MuxAssetStaticUpdate extends MuxUpdateShared {
  type: MuxUpdateStaticAssetEventType
  data: Asset
}
type MuxUpdate = MuxUploadUpdate | MuxAssetUpdate | MuxAssetStaticUpdate

[cwqt]

Made something a bit simpler than what else is in here;

export declare enum MUXHook {
    VideoAssetCreated = "video.asset.created",
    VideoAssetReady = "video.asset.ready",
    VideoAssetErrored = "video.asset.errored",
    VideoAssetUpdated = "video.asset.updated",
    VideoAssetDeleted = "video.asset.deleted",
    StaticRendReady = "video.asset.static_renditions.ready",
    StaticRendPreparing = "video.asset.static_renditions.preparing",
    StaticRendDeleted = "video.asset.static_renditions.deleted",
    StaticRendErrored = "video.asset.static_renditions.errored",
    MasterReady = "video.asset.master.ready",
    MasterPreparing = "video.asset.master.preparing",
    MasterDeleted = "video.asset.master.deleted",
    MasterErrored = "video.asset.master.errored",
    TrackCreated = "video.asset.track.created",
    TrackReady = "video.asset.track.ready",
    TrackErrored = "video.asset.track.errored",
    TrackDeleted = "video.asset.track.deleted",
    UploadAssetCreated = "video.upload.asset_created",
    UploadCancelled = "video.upload.cancelled",
    UploadCreated = "video.upload.created",
    UploadErrored = "video.upload.errored",
    StreamCompleted = "video.asset.live_stream_completed",
    StreamCreated = "video.live_stream.created",
    StreamConnected = "video.live_stream.connected",
    StreamRecording = "video.live_stream.recording",
    StreamActive = "video.live_stream.active",
    StreamDisconnected = "video.live_stream.disconnected",
    StreamIdle = "video.live_stream.idle",
    StreamUpdated = "video.live_stream.updated",
    StreamEnabled = "video.live_stream.enabled",
    StreamDisabled = "video.live_stream.deleted"
}
export interface IMUXHookResponse<T> {
    type: MUXHook;
    created_at: Date;
    object: {
        type: "asset" | "track" | "upload" | "live" | "simulcast-target";
        id: string;
    };
    id: string;
    environment: {
        name: string;
        id: string;
    };
    data: T;
    attempts: Array<{
        address: string;
        created_at: Date;
        id: string;
        max_attempts: number;
        response_body: string;
        response_headers: object;
        reponse_status_code: number;
        webhook_id: number;
    }>;
}

Then alongside the built in types, IMUXHookResponse<LiveStream>