@mux/ai 0.44.0 → 0.46.0

package/dist/workflows/index.js

@@ -33,12 +33,16 @@ var EnvSchema = z.object({
   ),
   MUX_SIGNING_KEY: optionalString("Mux signing key ID for signed playback URLs.", "Used to sign playback URLs"),
   MUX_PRIVATE_KEY: optionalString("Mux signing private key for signed playback URLs.", "Used to sign playback URLs"),
+  MUX_CUSTOM_DOMAIN: optionalString(
+    "Mux domain for image.* and stream.* playback URLs, e.g. staging.mux.com or a custom domain (defaults to mux.com).",
+    "Mux custom domain"
+  ),
   MUX_IMAGE_URL_OVERRIDE: optionalString(
-    "Override for Mux image base URL (defaults to https://image.mux.com).",
+    "Deprecated: use MUX_CUSTOM_DOMAIN. Override for Mux image base URL (defaults to https://image.mux.com).",
     "Mux image URL override"
   ),
   MUX_STREAM_URL_OVERRIDE: optionalString(
-    "Override for Mux stream base URL (defaults to https://stream.mux.com).",
+    "Deprecated: use MUX_CUSTOM_DOMAIN. Override for Mux stream base URL (defaults to https://stream.mux.com).",
     "Mux stream URL override"
   ),
   MUX_BASE_URL: optionalString(
@@ -157,7 +161,18 @@ function parseEnv() {
   }
   return parsedEnv.data;
 }
+var hasWarnedAboutDeprecatedUrlOverrides = false;
+function warnOnDeprecatedUrlOverrides(parsed) {
+  if (hasWarnedAboutDeprecatedUrlOverrides || !parsed.MUX_IMAGE_URL_OVERRIDE && !parsed.MUX_STREAM_URL_OVERRIDE) {
+    return;
+  }
+  hasWarnedAboutDeprecatedUrlOverrides = true;
+  console.warn(
+    "MUX_IMAGE_URL_OVERRIDE and MUX_STREAM_URL_OVERRIDE are deprecated and will be removed in a future release. Set MUX_CUSTOM_DOMAIN instead (e.g. MUX_CUSTOM_DOMAIN=staging.mux.com for image.staging.mux.com and stream.staging.mux.com)."
+  );
+}
 var env = parseEnv();
+warnOnDeprecatedUrlOverrides(env);
 var env_default = env;
 
 // src/lib/prompt-fragments.ts
@@ -1158,7 +1173,7 @@ function resolveDirectMuxCredentials(record) {
 function createWorkflowMuxClient(options) {
   return {
     async createClient() {
-      const { default: MuxClient } = await import("@mux/mux-node");
+      const { default: MuxClient } = await import("@mux/ts");
       return new MuxClient({
         tokenId: options.tokenId,
         tokenSecret: options.tokenSecret,
@@ -1824,8 +1839,7 @@ function timeRangesOverlap(firstStart, firstEnd, second) {
 }
 
 // src/lib/mux-url.ts
-var DEFAULT_MUX_IMAGE_ORIGIN = "https://image.mux.com";
-var DEFAULT_MUX_STREAM_ORIGIN = "https://stream.mux.com";
+var DEFAULT_MUX_DOMAIN = "mux.com";
 function normalizeOrigin(value, envVarName) {
   const trimmed = value.trim();
   const candidate = trimmed.includes("://") ? trimmed : `https://${trimmed}`;
@@ -1845,39 +1859,62 @@ function normalizeOrigin(value, envVarName) {
   }
   return parsed.origin;
 }
-function getMuxImageOrigin() {
-  const override = env_default.MUX_IMAGE_URL_OVERRIDE;
-  if (!override) {
-    return DEFAULT_MUX_IMAGE_ORIGIN;
+function buildPlaybackOrigin(service, customDomain, source) {
+  const invalidDomainError = new Error(
+    `Invalid ${source}. Provide a bare hostname (e.g. "media.example.com") with no scheme, port, credentials, query params, hash fragments, or path.`
+  );
+  const trimmed = customDomain.trim();
+  if (!trimmed) {
+    throw invalidDomainError;
+  }
+  let parsed;
+  try {
+    parsed = new URL(`https://${service}.${trimmed}`);
+  } catch {
+    throw invalidDomainError;
+  }
+  if (parsed.port || parsed.username || parsed.password || parsed.search || parsed.hash || parsed.pathname !== "/") {
+    throw invalidDomainError;
   }
-  return normalizeOrigin(override, "MUX_IMAGE_URL_OVERRIDE");
+  return parsed.origin;
 }
-function getMuxStreamOrigin() {
-  const override = env_default.MUX_STREAM_URL_OVERRIDE;
-  if (!override) {
-    return DEFAULT_MUX_STREAM_ORIGIN;
+async function resolveMuxPlaybackOrigin(service, credentials) {
+  "use step";
+  const { muxCustomDomain } = await resolveWorkflowCredentials(credentials);
+  if (muxCustomDomain) {
+    return buildPlaybackOrigin(service, muxCustomDomain, "muxCustomDomain");
+  }
+  const legacyOverrideEnvVarName = service === "image" ? "MUX_IMAGE_URL_OVERRIDE" : "MUX_STREAM_URL_OVERRIDE";
+  const legacyOverride = env_default[legacyOverrideEnvVarName];
+  if (legacyOverride) {
+    return normalizeOrigin(legacyOverride, legacyOverrideEnvVarName);
   }
-  return normalizeOrigin(override, "MUX_STREAM_URL_OVERRIDE");
+  if (env_default.MUX_CUSTOM_DOMAIN) {
+    return buildPlaybackOrigin(service, env_default.MUX_CUSTOM_DOMAIN, "MUX_CUSTOM_DOMAIN");
+  }
+  return buildPlaybackOrigin(service, DEFAULT_MUX_DOMAIN, "custom domain");
+}
+async function getMuxImageOrigin(credentials) {
+  return resolveMuxPlaybackOrigin("image", credentials);
+}
+async function getMuxStreamOrigin(credentials) {
+  return resolveMuxPlaybackOrigin("stream", credentials);
 }
-function getMuxImageBaseUrl(playbackId, assetType) {
-  const origin = getMuxImageOrigin();
+async function getMuxImageBaseUrl(playbackId, assetType, credentials) {
+  const origin = await getMuxImageOrigin(credentials);
   return `${origin}/${playbackId}/${assetType}.png`;
 }
-function getMuxStoryboardBaseUrl(playbackId) {
-  return getMuxImageBaseUrl(playbackId, "storyboard");
+async function getMuxStoryboardBaseUrl(playbackId, credentials) {
+  return getMuxImageBaseUrl(playbackId, "storyboard", credentials);
 }
-function getMuxThumbnailBaseUrl(playbackId) {
-  return getMuxImageBaseUrl(playbackId, "thumbnail");
+async function getMuxThumbnailBaseUrl(playbackId, credentials) {
+  return getMuxImageBaseUrl(playbackId, "thumbnail", credentials);
 }
 
 // src/lib/url-signing.ts
 async function createSigningClient(context) {
-  const { default: MuxClient } = await import("@mux/mux-node");
+  const { default: MuxClient } = await import("@mux/ts");
   return new MuxClient({
-    // These are not needed for signing, but the SDK requires them
-    // Using empty strings as we only need the jwt functionality
-    tokenId: env_default.MUX_TOKEN_ID || "",
-    tokenSecret: env_default.MUX_TOKEN_SECRET || "",
     jwtSigningKey: context.keyId,
     jwtPrivateKey: context.keySecret
   });
@@ -1911,7 +1948,7 @@ async function signUrl(url, playbackId, type = "video", params, credentials) {
 var DEFAULT_STORYBOARD_WIDTH = 640;
 async function getStoryboardUrl(playbackId, width = DEFAULT_STORYBOARD_WIDTH, shouldSign = false, credentials, scope) {
   "use step";
-  const baseUrl = getMuxStoryboardBaseUrl(playbackId);
+  const baseUrl = await getMuxStoryboardBaseUrl(playbackId, credentials);
   const params = { width };
   if (scope?.startTime !== void 0) {
     params.asset_start_time = scope.startTime;
@@ -2473,7 +2510,7 @@ function concatenateVttSegments(segments, preamble = "WEBVTT") {
 }
 async function buildTranscriptUrl(playbackId, trackId, shouldSign = false, credentials) {
   "use step";
-  const baseUrl = `${getMuxStreamOrigin()}/${playbackId}/text/${trackId}.vtt`;
+  const baseUrl = `${await getMuxStreamOrigin(credentials)}/${playbackId}/text/${trackId}.vtt`;
   if (shouldSign) {
     return signUrl(baseUrl, playbackId, "video", void 0, credentials);
   }
@@ -5348,25 +5385,22 @@ async function getHeatmapForAsset(assetId, options = {}) {
   "use step";
   return fetchHeatmap("assets", assetId, options);
 }
-function transformHeatmapResponse(response) {
-  return {
-    assetId: response.data.asset_id,
-    videoId: response.data.video_id,
-    playbackId: response.data.playback_id,
-    heatmap: response.data.heatmap,
-    timeframe: response.timeframe
-  };
-}
 async function fetchHeatmap(identifierType, id, options) {
   "use step";
   const { timeframe = "7:days", credentials } = options;
   const muxClient = await getMuxClientFromEnv(credentials);
   const mux = await muxClient.createClient();
-  const queryParams = new URLSearchParams();
-  queryParams.append("timeframe[]", timeframe);
-  const path = `/data/v1/engagement/${identifierType}/${id}/heatmap?${queryParams.toString()}`;
-  const response = await mux.get(path);
-  return transformHeatmapResponse(response);
+  const query = { timeframe: [timeframe] };
+  const resource = identifierType === "playback-ids" ? mux.data.engagement.playbackIds : mux.data.engagement[identifierType];
+  const response = await resource.heatmap(id, query);
+  const { data } = response;
+  return {
+    assetId: data.asset_id ?? (identifierType === "assets" ? id : void 0),
+    videoId: data.video_id ?? (identifierType === "videos" ? id : void 0),
+    playbackId: data.playback_id ?? (identifierType === "playback-ids" ? id : void 0),
+    heatmap: data.heatmap,
+    timeframe: response.timeframe
+  };
 }
 
 // src/primitives/hotspots.ts
@@ -5375,43 +5409,37 @@ async function getHotspotsForAsset(assetId, options = {}) {
   const response = await fetchHotspots("assets", assetId, options);
   return response.hotspots;
 }
-function transformHotspotResponse(response) {
-  return {
-    assetId: response.data.asset_id,
-    videoId: response.data.video_id,
-    playbackId: response.data.playback_id,
-    hotspots: response.data.hotspots.map((h) => ({
-      startMs: h.start_ms,
-      endMs: h.end_ms,
-      score: h.score
-    }))
-  };
-}
 async function fetchHotspots(identifierType, id, options) {
   "use step";
   const {
     limit = 5,
     orderDirection = "desc",
-    orderBy = "score",
     timeframe = "7:days",
     credentials
   } = options;
   const muxClient = await getMuxClientFromEnv(credentials);
   const mux = await muxClient.createClient();
-  const queryParams = new URLSearchParams();
-  queryParams.append("limit", String(limit));
-  queryParams.append("order_direction", orderDirection);
-  queryParams.append("order_by", orderBy);
-  queryParams.append("timeframe[]", timeframe);
-  const path = `/data/v1/engagement/${identifierType}/${id}/hotspots?${queryParams.toString()}`;
-  const response = await mux.get(path);
-  return transformHotspotResponse(response);
+  const query = {
+    limit,
+    order_direction: orderDirection,
+    timeframe: [timeframe]
+  };
+  const resource = identifierType === "playback-ids" ? mux.data.engagement.playbackIds : mux.data.engagement[identifierType];
+  const response = await resource.hotspots(id, query);
+  const { data } = response;
+  return {
+    assetId: data.asset_id ?? (identifierType === "assets" ? id : void 0),
+    videoId: data.video_id ?? (identifierType === "videos" ? id : void 0),
+    playbackId: data.playback_id ?? (identifierType === "playback-ids" ? id : void 0),
+    hotspots: data.hotspots.map((h) => ({
+      startMs: h.start_ms,
+      endMs: h.end_ms,
+      score: h.score
+    }))
+  };
 }
 
 // src/primitives/shots.ts
-function getShotsPath(assetId) {
-  return `/video/v1/assets/${assetId}/shots`;
-}
 function mapManifestShots(shots) {
   let usedDeprecatedField = false;
   const mapped = shots.map((shot, index) => {
@@ -5451,29 +5479,35 @@ async function fetchShotsFromManifest(shotsManifestUrl) {
   }
   return mapManifestShots(manifest.shots);
 }
-async function transformShotsResponse(response) {
-  switch (response.data.status) {
+async function transformShotsResponse(data) {
+  switch (data.status) {
     case "pending":
       return {
         status: "pending",
-        createdAt: response.data.created_at
+        createdAt: data.created_at
       };
-    case "errored":
+    case "errored": {
+      const details = data.errors ?? data.error;
       return {
         status: "errored",
-        createdAt: response.data.created_at,
-        error: response.data.error
+        createdAt: data.created_at,
+        error: {
+          type: details?.type ?? "unknown",
+          messages: details?.messages ?? []
+        }
       };
+    }
     case "completed":
+      if (!data.shots_manifest_url) {
+        throw new Error("Completed shots response is missing shots_manifest_url");
+      }
       return {
         status: "completed",
-        createdAt: response.data.created_at,
-        shots: await fetchShotsFromManifest(response.data.shots_manifest_url)
+        createdAt: data.created_at,
+        shots: await fetchShotsFromManifest(data.shots_manifest_url)
       };
-    default: {
-      const exhaustiveCheck = response.data;
-      throw new Error(`Unsupported shots response: ${JSON.stringify(exhaustiveCheck)}`);
-    }
+    default:
+      throw new Error(`Unsupported shots status '${data.status}'`);
   }
 }
 async function getShotsForAsset(assetId, options = {}) {
@@ -5481,10 +5515,8 @@ async function getShotsForAsset(assetId, options = {}) {
   const { credentials } = options;
   const muxClient = await getMuxClientFromEnv(credentials);
   const mux = await muxClient.createClient();
-  const response = await mux.get(
-    getShotsPath(assetId)
-  );
-  return await transformShotsResponse(response);
+  const data = await mux.video.assets.retrieveShots(assetId);
+  return await transformShotsResponse(data);
 }
 
 // src/workflows/engagement-insights.ts
@@ -5722,7 +5754,7 @@ function mapShotsToHotspots(shots, hotspots) {
 }
 async function getThumbnailUrlsForHotspots(playbackId, hotspots, options = {}) {
   const { width = 640, shouldSign = false, credentials } = options;
-  const baseUrl = getMuxThumbnailBaseUrl(playbackId);
+  const baseUrl = await getMuxThumbnailBaseUrl(playbackId, credentials);
   const urlPromises = hotspots.map(async (h) => {
     const time = Math.floor(h.startMs / 1e3);
     if (shouldSign) {
@@ -6823,7 +6855,7 @@ async function getThumbnailUrls(playbackId, duration, options = {}) {
     }
     timestamps = newTimestamps;
   }
-  const baseUrl = getMuxThumbnailBaseUrl(playbackId);
+  const baseUrl = await getMuxThumbnailBaseUrl(playbackId, credentials);
   const urlPromises = timestamps.map(async (time) => {
     const url = shouldSign ? await signUrl(baseUrl, playbackId, "thumbnail", { time, width }, credentials) : `${baseUrl}?time=${time}&width=${width}`;
     return { url, time };
@@ -7287,7 +7319,7 @@ function filterTimestampsWithinExclusiveScope(timestampsMs, scope) {
 async function getThumbnailUrlsFromTimestamps(playbackId, timestampsMs, options) {
   "use step";
   const { width, shouldSign, credentials } = options;
-  const baseUrl = getMuxThumbnailBaseUrl(playbackId);
+  const baseUrl = await getMuxThumbnailBaseUrl(playbackId, credentials);
   const times = [...new Set(timestampsMs.map(toThumbnailTimeSeconds))];
   const urlPromises = times.map(async (time) => {
     const url = shouldSign ? await signUrl(baseUrl, playbackId, "thumbnail", { time, width }, credentials) : `${baseUrl}?time=${time}&width=${width}`;
@@ -8471,7 +8503,7 @@ async function translateAudio(assetId, toLanguageCode, options = {}) {
         { type: "validation_error" }
       );
     }
-    let audioUrl = `${getMuxStreamOrigin()}/${playbackId}/audio.m4a`;
+    let audioUrl = `${await getMuxStreamOrigin(credentials)}/${playbackId}/audio.m4a`;
     if (policy === "signed") {
       audioUrl = await signUrl(audioUrl, playbackId, "video", void 0, credentials);
     }