@fastpix/fastpix-node 2.0.1 → 2.0.3

package/samples/analytics/metrics.ts

@@ -0,0 +1,117 @@
+/**
+ * Metrics API Samples
+ * 
+ * This file demonstrates how to use the Metrics API to:
+ * - List breakdown values
+ * - List overall values
+ * - Get timeseries data
+ * - List comparison values
+ * 
+ * Run this sample:
+ * npx tsx analytics/metrics.ts
+ */
+
+import { createFastpixClient, runSample } from "../common/setup.js";
+import { logResponse } from "../common/config.js";
+
+async function listBreakdownValues() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.metrics.listBreakdownValues({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    dimension: "device_type",
+    metric: "views",
+  });
+
+  logResponse("List Breakdown Values", result);
+  return result;
+}
+
+async function listOverallValues() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.metrics.listOverallValues({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    metric: "views",
+  });
+
+  logResponse("List Overall Values", result);
+  return result;
+}
+
+async function getTimeseriesData() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.metrics.getTimeseriesData({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    metric: "views",
+    interval: "day",
+  });
+
+  logResponse("Get Timeseries Data", result);
+  return result;
+}
+
+async function listComparisonValues() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.metrics.listComparisonValues({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    compareTimespan: ["2023-01-01T00:00:00Z", "2023-12-31T23:59:59Z"],
+    metric: "views",
+  });
+
+  logResponse("List Comparison Values", result);
+  return result;
+}
+
+async function getMultipleMetrics() {
+  const fastpix = createFastpixClient();
+  
+  const metrics = ["views", "unique_viewers", "play_time"];
+  const results = [];
+
+  for (const metric of metrics) {
+    const result = await fastpix.metrics.listOverallValues({
+      timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+      metric: metric,
+    });
+    results.push({ metric, result });
+  }
+
+  logResponse("Get Multiple Metrics", results);
+  return results;
+}
+
+async function getBreakdownByMultipleDimensions() {
+  const fastpix = createFastpixClient();
+  
+  const dimensions = ["device_type", "browser_name", "country"];
+  const results = [];
+
+  for (const dimension of dimensions) {
+    const result = await fastpix.metrics.listBreakdownValues({
+      timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+      dimension: dimension,
+      metric: "views",
+    });
+    results.push({ dimension, result });
+  }
+
+  logResponse("Get Breakdown by Multiple Dimensions", results);
+  return results;
+}
+
+async function main() {
+  console.log("📈 Metrics API Samples");
+  console.log("======================");
+  
+  await runSample("List Breakdown Values", listBreakdownValues);
+  await runSample("List Overall Values", listOverallValues);
+  await runSample("Get Timeseries Data", getTimeseriesData);
+  await runSample("List Comparison Values", listComparisonValues);
+  await runSample("Get Multiple Metrics", getMultipleMetrics);
+  await runSample("Get Breakdown by Multiple Dimensions", getBreakdownByMultipleDimensions);
+}
+
+main().catch(console.error);

package/samples/analytics/views.ts

@@ -0,0 +1,120 @@
+/**
+ * Views API Samples
+ * 
+ * This file demonstrates how to use the Views API to:
+ * - List video views
+ * - Get video view details
+ * - List by top content
+ * - Get concurrent viewers timeseries
+ * - Get concurrent viewers breakdown
+ * 
+ * Run this sample:
+ * npx tsx analytics/views.ts
+ */
+
+import { createFastpixClient, runSample } from "../common/setup.js";
+import { logResponse } from "../common/config.js";
+
+async function listVideoViews() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.views.listVideoViews({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    limit: 10,
+    offset: 0,
+  });
+
+  logResponse("List Video Views", result);
+  return result;
+}
+
+async function listVideoViewsWithFilters() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.views.listVideoViews({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    filterby: ["device_type", "browser_name"],
+    limit: 5,
+    offset: 0,
+    orderBy: "timestamp",
+    sort: "desc",
+  });
+
+  logResponse("List Video Views with Filters", result);
+  return result;
+}
+
+async function getVideoViewDetails() {
+  const fastpix = createFastpixClient();
+  
+  // First, get a view ID from the list
+  const views = await fastpix.views.listVideoViews({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    limit: 1,
+  });
+
+  const viewId = views.listVideoViewsSuccessResponse?.data?.views?.[0]?.viewId;
+  
+  if (!viewId) {
+    console.log("⚠️  No views found. Please ensure you have some video views first.");
+    return;
+  }
+
+  const result = await fastpix.views.getVideoViewDetails({
+    viewId: viewId,
+  });
+
+  logResponse("Get Video View Details", result);
+  return result;
+}
+
+async function listByTopContent() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.views.listByTopContent({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    limit: 5,
+    offset: 0,
+  });
+
+  logResponse("List by Top Content", result);
+  return result;
+}
+
+async function getConcurrentViewersTimeseries() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.views.getDataViewlistCurrentViewsGetTimeseriesViews({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    interval: "hour",
+  });
+
+  logResponse("Get Concurrent Viewers Timeseries", result);
+  return result;
+}
+
+async function getConcurrentViewersBreakdown() {
+  const fastpix = createFastpixClient();
+  
+  const result = await fastpix.views.getDataViewlistCurrentViewsFilter({
+    timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+    filterby: ["device_type", "country"],
+  });
+
+  logResponse("Get Concurrent Viewers Breakdown", result);
+  return result;
+}
+
+async function main() {
+  console.log("📊 Views API Samples");
+  console.log("====================");
+  
+  await runSample("List Video Views", listVideoViews);
+  await runSample("List Video Views with Filters", listVideoViewsWithFilters);
+  await runSample("Get Video View Details", getVideoViewDetails);
+  await runSample("List by Top Content", listByTopContent);
+  await runSample("Get Concurrent Viewers Timeseries", getConcurrentViewersTimeseries);
+  await runSample("Get Concurrent Viewers Breakdown", getConcurrentViewersBreakdown);
+}
+
+main().catch(console.error);

package/samples/common/config.ts

@@ -0,0 +1,84 @@
+import dotenv from "dotenv";
+dotenv.config();
+
+/**
+ * Common configuration for all samples
+ * 
+ * Set your credentials using environment variables:
+ * - FASTPIX_USERNAME: Your FastPix access token
+ * - FASTPIX_PASSWORD: Your FastPix secret key
+ * 
+ * Or update the values directly below (not recommended for production)
+ */
+
+export const config = {
+  // Use environment variables if available, otherwise fallback to placeholder values
+  username: process.env.FASTPIX_USERNAME || "your-access-token",
+  password: process.env.FASTPIX_PASSWORD || "your-secret-key",
+  
+  // Sample video URL for testing
+  sampleVideoUrl: "https://static.fastpix.io/sample.mp4",
+  
+  // Sample stream configuration
+  sampleStreamName: "Sample Live Stream",
+  sampleStreamDescription: "A sample live stream created via SDK",
+  
+  // Sample playlist configuration
+  samplePlaylistName: "Sample Playlist",
+  samplePlaylistDescription: "A sample playlist created via SDK",
+};
+
+/**
+ * Helper function to validate configuration
+ */
+export function validateConfig(): void {
+  if (config.username === "your-access-token" || config.password === "your-secret-key") {
+    console.warn("⚠️  Warning: Using placeholder credentials. Please set FASTPIX_USERNAME and FASTPIX_PASSWORD environment variables.");
+    console.log("   You can create a .env file in the samples directory with:");
+    console.log("   FASTPIX_USERNAME=your-actual-token");
+    console.log("   FASTPIX_PASSWORD=your-actual-secret");
+  }
+}
+
+/**
+ * Helper function to log API responses
+ */
+export function logResponse(operation: string, response: any): void {
+  console.log(`\n✅ ${operation} completed successfully:`);
+  console.log(JSON.stringify(response, null, 2));
+}
+
+/**
+ * Helper function to log errors
+ */
+export function logError(operation: string, error: any): void {
+  console.error(`\n❌ ${operation} failed:`);
+  if (error instanceof Error) {
+    console.error(`   Error: ${error.message}`);
+    if (error.stack) {
+      console.error(`   Stack: ${error.stack.split('\n').slice(0, 3).join('\n')}`);
+    }
+  } else {
+    console.error(`   Error: ${JSON.stringify(error, null, 2)}`);
+  }
+}
+
+/**
+ * Helper function to check if an error is a specific FastPix error type
+ */
+export function isFastPixError(error: any): boolean {
+  return error && typeof error === 'object' && 'statusCode' in error;
+}
+
+/**
+ * Helper function to get user-friendly error message
+ */
+export function getErrorMessage(error: any): string {
+  if (error instanceof Error) {
+    return error.message;
+  }
+  if (isFastPixError(error)) {
+    return `HTTP ${error.statusCode}: ${error.message || 'Unknown error'}`;
+  }
+  return String(error);
+}

package/samples/common/setup.ts

@@ -0,0 +1,42 @@
+import { Fastpix } from "../../dist/esm/index.js";
+import { config, validateConfig } from "./config.js";
+
+/**
+ * Common setup function for all samples
+ * Creates and configures the FastPix SDK instance
+ */
+export function createFastpixClient(): Fastpix {
+  validateConfig();
+  
+  return new Fastpix({
+    security: {
+      username: config.username,
+      password: config.password,
+    },
+  });
+}
+
+/**
+ * Helper function to run samples with error handling
+ */
+export async function runSample(
+  sampleName: string,
+  sampleFunction: () => Promise<void>
+): Promise<void> {
+  try {
+    console.log(`\n🚀 Running ${sampleName}...`);
+    await sampleFunction();
+    console.log(`\n✅ ${sampleName} completed successfully!`);
+  } catch (error) {
+    console.error(`\n❌ ${sampleName} failed:`);
+    if (error instanceof Error) {
+      console.error(`   Error: ${error.message}`);
+      if (error.stack) {
+        console.error(`   Stack: ${error.stack.split('\n').slice(0, 3).join('\n')}`);
+      }
+    } else {
+      console.error(`   Error: ${JSON.stringify(error, null, 2)}`);
+    }
+    throw error;
+  }
+}

package/samples/comprehensive-example.ts

@@ -0,0 +1,267 @@
+/**
+ * Comprehensive FastPix SDK Example
+ * 
+ * This example demonstrates a complete workflow using multiple FastPix APIs:
+ * 1. Create media from URL
+ * 2. Create a live stream
+ * 3. Create playlists
+ * 4. Generate analytics
+ * 5. Apply AI features
+ * 6. Set up security
+ * 
+ * Run this sample:
+ * npx tsx comprehensive-example.ts
+ */
+
+import { createFastpixClient, runSample } from "./common/setup.js";
+import { config, logResponse, getErrorMessage } from "./common/config.js";
+
+interface WorkflowData {
+  mediaId?: string;
+  streamId?: string;
+  playlistId?: string;
+  playbackId?: string;
+  signingKeyId?: string;
+}
+
+async function comprehensiveWorkflow() {
+  const fastpix = createFastpixClient();
+  const data: WorkflowData = {};
+
+  console.log("🚀 Starting Comprehensive FastPix SDK Workflow");
+  console.log("==============================================");
+
+  // Step 1: Create Media
+  console.log("\n📹 Step 1: Creating Media");
+  console.log("-------------------------");
+  
+  const mediaResult = await fastpix.inputVideo.createMedia({
+    inputs: [
+      {
+        type: "video",
+        url: config.sampleVideoUrl,
+      },
+    ],
+    metadata: {
+      title: "Comprehensive Example Video",
+      description: "A video created for the comprehensive SDK example",
+      category: "demo",
+      tags: ["sdk", "example", "comprehensive"],
+    },
+    accessPolicy: "public",
+  });
+
+  if (mediaResult.createMediaSuccessResponse?.data?.id) {
+    data.mediaId = mediaResult.createMediaSuccessResponse.data.id;
+    console.log(`✅ Created media with ID: ${data.mediaId}`);
+  }
+
+  // Step 2: Create Live Stream
+  console.log("\n🔴 Step 2: Creating Live Stream");
+  console.log("-------------------------------");
+  
+  const streamResult = await fastpix.startLiveStream.createNewStream({
+    requestBody: {
+      metadata: {
+        name: "Comprehensive Example Stream",
+        description: "A live stream created for the comprehensive SDK example",
+        category: "demo",
+      },
+      reconnectWindow: 30,
+      privacy: "public",
+    },
+  });
+
+  if (streamResult.data?.id) {
+    data.streamId = streamResult.data.id;
+    console.log(`✅ Created stream with ID: ${data.streamId}`);
+    console.log(`📡 Stream Key: ${streamResult.data.streamKey || 'N/A'}`);
+  }
+
+  // Step 3: Create Playlist
+  console.log("\n📋 Step 3: Creating Playlist");
+  console.log("----------------------------");
+  
+  const playlistResult = await fastpix.playlist.createAPlaylist({
+    requestBody: {
+      name: "Comprehensive Example Playlist",
+      description: "A playlist created for the comprehensive SDK example",
+      metadata: {
+        category: "demo",
+        created_by: "sdk_example",
+      },
+    },
+  });
+
+  if (playlistResult.createAPlaylistSuccessResponse?.data?.id) {
+    data.playlistId = playlistResult.createAPlaylistSuccessResponse.data.id;
+    console.log(`✅ Created playlist with ID: ${data.playlistId}`);
+  }
+
+  // Step 4: Add Media to Playlist
+  if (data.mediaId && data.playlistId) {
+    console.log("\n➕ Step 4: Adding Media to Playlist");
+    console.log("-----------------------------------");
+    
+    await fastpix.playlist.addMediaToPlaylist({
+      playlistId: data.playlistId,
+      requestBody: {
+        mediaId: data.mediaId,
+      },
+    });
+    console.log("✅ Added media to playlist");
+  }
+
+  // Step 5: Create Playback ID
+  if (data.mediaId) {
+    console.log("\n▶️  Step 5: Creating Playback ID");
+    console.log("--------------------------------");
+    
+    const playbackResult = await fastpix.playback.createMediaPlaybackId({
+      mediaId: data.mediaId,
+      requestBody: {
+        policy: "public",
+      },
+    });
+
+    if (playbackResult.createMediaPlaybackIdSuccessResponse?.data?.id) {
+      data.playbackId = playbackResult.createMediaPlaybackIdSuccessResponse.data.id;
+      console.log(`✅ Created playback ID: ${data.playbackId}`);
+    }
+  }
+
+  // Step 6: Apply AI Features
+  if (data.mediaId) {
+    console.log("\n🤖 Step 6: Applying AI Features");
+    console.log("-------------------------------");
+    
+    try {
+      // Enable summary generation
+      await fastpix.inVideoAIFeatures.updateMediaSummary({
+        mediaId: data.mediaId,
+        requestBody: { enabled: true },
+      });
+      console.log("✅ Enabled video summary generation");
+
+      // Enable chapter generation
+      await fastpix.inVideoAIFeatures.updateMediaChapters({
+        mediaId: data.mediaId,
+        requestBody: { enabled: true },
+      });
+      console.log("✅ Enabled video chapter generation");
+
+      // Enable content moderation
+      await fastpix.inVideoAIFeatures.updateMediaModeration({
+        mediaId: data.mediaId,
+        requestBody: {
+          enabled: true,
+          nsfw: true,
+          profanity: true,
+        },
+      });
+      console.log("✅ Enabled content moderation");
+    } catch (error) {
+      console.log("⚠️  AI features may not be available for this media");
+      console.log(`   Error: ${getErrorMessage(error)}`);
+    }
+  }
+
+  // Step 7: Create Signing Key
+  console.log("\n🔐 Step 7: Creating Signing Key");
+  console.log("-------------------------------");
+  
+  const signingKeyResult = await fastpix.signingKeys.createSigningKey();
+  if (signingKeyResult.data?.id) {
+    data.signingKeyId = signingKeyResult.data.id;
+    console.log(`✅ Created signing key with ID: ${data.signingKeyId}`);
+    console.log("📝 Private key generated (stored securely)");
+  }
+
+  // Step 8: Generate Analytics
+  console.log("\n📊 Step 8: Generating Analytics");
+  console.log("-------------------------------");
+  
+  try {
+    // Get dimensions
+    const dimensions = await fastpix.dimensions.listDimensions();
+    console.log(`✅ Found ${dimensions.listDimensionsSuccessResponse?.data?.dimensions?.length || 0} dimensions`);
+
+    // Get metrics
+    const metrics = await fastpix.metrics.listOverallValues({
+      timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+      metric: "views",
+    });
+    console.log("✅ Retrieved performance metrics");
+
+    // Get views
+    const views = await fastpix.views.listVideoViews({
+      timespan: ["2024-01-01T00:00:00Z", "2024-12-31T23:59:59Z"],
+      limit: 5,
+    });
+    console.log(`✅ Retrieved ${views.listVideoViewsSuccessResponse?.data?.views?.length || 0} video views`);
+  } catch (error) {
+    console.log("⚠️  Analytics data may not be available yet");
+    console.log(`   Error: ${getErrorMessage(error)}`);
+  }
+
+  // Step 9: Display Summary
+  console.log("\n📋 Workflow Summary");
+  console.log("===================");
+  console.log(`Media ID: ${data.mediaId || 'Not created'}`);
+  console.log(`Stream ID: ${data.streamId || 'Not created'}`);
+  console.log(`Playlist ID: ${data.playlistId || 'Not created'}`);
+  console.log(`Playback ID: ${data.playbackId || 'Not created'}`);
+  console.log(`Signing Key ID: ${data.signingKeyId || 'Not created'}`);
+
+  // Step 10: Cleanup (Optional)
+  console.log("\n🧹 Cleanup Options");
+  console.log("==================");
+  console.log("To clean up created resources, uncomment the cleanup section below");
+  
+  // Uncomment to clean up resources
+  /*
+  if (data.signingKeyId) {
+    await fastpix.signingKeys.deleteSigningKey({ keyId: data.signingKeyId });
+    console.log("🗑️  Deleted signing key");
+  }
+  
+  if (data.playbackId) {
+    await fastpix.playback.deleteMediaPlaybackId({ playbackId: data.playbackId });
+    console.log("🗑️  Deleted playback ID");
+  }
+  
+  if (data.playlistId) {
+    await fastpix.playlist.deleteAPlaylist({ playlistId: data.playlistId });
+    console.log("🗑️  Deleted playlist");
+  }
+  
+  if (data.streamId) {
+    await fastpix.manageLiveStream.deleteLiveStream({ streamId: data.streamId });
+    console.log("🗑️  Deleted stream");
+  }
+  
+  if (data.mediaId) {
+    await fastpix.manageVideos.deleteMedia({ mediaId: data.mediaId });
+    console.log("🗑️  Deleted media");
+  }
+  */
+
+  return data;
+}
+
+async function main() {
+  try {
+    await runSample("Comprehensive Workflow", comprehensiveWorkflow);
+    console.log("\n🎉 Comprehensive workflow completed successfully!");
+    console.log("\n💡 Next Steps:");
+    console.log("1. Check your FastPix dashboard to see the created resources");
+    console.log("2. Use the stream key to start a live broadcast");
+    console.log("3. Use the playback ID to embed videos in your application");
+    console.log("4. Monitor analytics and AI features as they process");
+  } catch (error) {
+    console.error("\n❌ Workflow failed:");
+    console.error(`   Error: ${getErrorMessage(error)}`);
+  }
+}
+
+main().catch(console.error);