@fastpix/fastpix-node 1.0.0

package/README.md

@@ -0,0 +1,509 @@
+# Introduction:
+
+The FastPix Node.js SDK, written in typescript, simplifies integration with the FastPix platform. This SDK is designed for secure and efficient communication with the FastPix API, enabling easy management of media uploads, live streaming, and simulcasting. It is intended for use with Node.js (version >= 18).
+
+# Key Features:
+
+- ## Media API:
+
+  - **Upload Media**: Upload media files seamlessly from URLs or devices.
+  - **Manage Media**: Perform operations such as listing, fetching, updating, and deleting media assets.
+  - **Playback IDs**: Generate and manage playback IDs for media access.
+
+- ## Live API:
+
+  - **Create & Manage Live Streams:**: Create, list, update, and delete live streams effortlessly.
+  - **Control Stream Access**: Generate playback IDs for live streams to control and manage access.
+  - **Simulcast to Multiple Platforms**: Stream content to multiple platforms simultaneously.
+
+For detailed usage, refer to the [FastPix API Reference](https://docs.fastpix.io/reference).
+
+# Prerequisites:
+
+## Getting started with FastPix:
+
+To get started with the **FastPix Node SDK**, ensure you have the following:
+
+- The FastPix APIs are authenticated using an **Access Token** and a **Secret Key**. You must generate these credentials to use the SDK.
+
+- Follow the steps in the [Authentication with Access Tokens](https://docs.fastpix.io/docs/basic-authentication) guide to obtain your credentials.
+
+# Installation:
+
+To install the SDK, you can use npm or your favourite node package manager 😉:
+
+```bash
+npm install @fastpix/fastpix-node
+```
+
+# Basic Usage:
+
+## Importing the SDK
+
+Depending on your project setup, you can import the SDK using either `import` or `require`.
+
+### Using `import` (ES Modules)
+
+If your project supports ES Modules, use the `import` syntax:
+
+```javascript
+import Client from "@fastpix/fastpix-node";
+```
+
+### Using `require` (CommonJS)
+
+If you're using CommonJS modules, you can use `require`:
+
+```javascript
+const Client = require("@fastpix/fastpix-node").default;
+```
+
+# Initialization:
+
+Initialize the FastPix SDK with your API credentials.
+
+```javascript
+import Client from "@fastpix/fastpix-node";
+
+const fastpix = new Client({
+  accessTokenId: "your-access-token-id",
+  secretKey: "your-secret-key",
+});
+```
+
+## Example Usage:
+
+Below is an example of configuring `FastPix Node SDK` into your project.
+
+```javascript
+// Using import (ES Modules)
+import Client from "@fastpix/fastpix-node";
+
+// or using require (CommonJS)
+// const Client = require("@fastpix/fastpix-node").default;
+
+// Initialize the FastPix SDK with your Access Token ID and Secret Key
+const fastpix = new Client({
+  accessTokenId: "your-access-token-id", // Replace with your Access Token ID
+  secretKey: "your-secret-key", // Replace with your Secret Key
+});
+
+async function main() {
+  
+  // Create a request payload for uploading media from a URL
+  const uploadUrlRequest = {
+    inputs: [
+      {
+        type: "video",
+        url: "https://static.fastpix.io/sample.mp4",
+      },
+    ],
+    metadata: {
+      video_title: "Big_Buck_Bunny",
+    },
+    accessPolicy: "public",
+  };
+
+  const response = await fastpix.uploadMediaFromUrl(uploadUrlRequest);
+  console.log("Media Id:", response.data.id);
+}
+
+main();
+```
+
+# Usage:
+
+## 1. Media Operations:
+
+### 1.1. Media Uploads:
+
+#### Upload Media from a URL:
+
+Use the `uploadMediaFromUrl` method to upload media directly from a URL. For detailed configuration options, refer to the [Create media from URL](./docs/VideoOnDemand/UploadMedia.md#method-uploadmediafromurl) API documentation.
+
+```javascript
+// Define the request payload for uploading media from a URL.
+const mediaFromUrlRequest = {
+  inputs: [
+    {
+      type: "video", // Specifies the type of media being uploaded (e.g., "video").
+      url: "https://static.fastpix.io/sample.mp4", // URL of the media file to be uploaded.
+    },
+  ],
+  metadata: {
+    video_title: "Big_Buck_Bunny", // Metadata to associate with the media, such as its title.
+  },
+  accessPolicy: "public", // Access policy for the media ("public" or "private").
+};
+
+const mediaFromUrlResponse =
+  await fastpix.uploadMediaFromUrl(mediaFromUrlRequest);
+console.log("Upload Response:", mediaFromUrlResponse);
+```
+
+#### Upload Media from a Local Device:
+
+Use the `uploadMediaFromDevice` method to obtain a `signedUrl` and upload media directly from a local device. For more details on configuration options, refer to the [Upload media from device](./docs/VideoOnDemand/UploadMedia.md#method-uploadmediafromdevice) API documentation.
+
+```javascript
+// Define the request payload for uploading media from a device.
+const mediaFromDeviceRequest = {
+  corsOrigin: "*", // Specifies the allowed origin for CORS (Cross-Origin Resource Sharing). "*" allows all origins.
+  pushMediaSettings: {
+    accessPolicy: "private", // Sets the access policy for the uploaded media (e.g., "private" or "public").
+    optimizeAudio: true, // Enables audio optimization for the uploaded media.
+    maxResolution: "1080p", // Specifies the maximum resolution allowed for the uploaded media.
+  },
+};
+
+const mediaFromDeviceResponse = await fastpix.uploadMediaFromDevice(
+  mediaFromDeviceRequest
+);
+console.log("Upload Response:", mediaFromDeviceResponse);
+```
+
+### 1.2. Media Management:
+
+#### Get List of All Media:
+
+Use the `getAllMediaAssets` method to fetch a list of all media assets. You can customize the query by modifying parameters such as `limit`, `offset`, and `orderBy`. Refer to the [Get list of all media](./docs/VideoOnDemand/ManageMedia.md#method-getallmediaassets) API documentation for the accepted values.
+
+```javascript
+// Define the parameters for fetching media assets in a separate variable.
+const mediaQueryParams = {
+  limit: 20,    // Number of assets to fetch in one request (between 1 and 50)
+  offset: 5,    // Pagination starting position
+  orderBy: "asc"  // Sorting order of the assets ("asc" for ascending)
+};
+
+const mediaAssets = await fastpix.getAllMediaAssets(mediaQueryParams);
+console.log("Fetched Media Assets:", mediaAssets);
+```
+
+#### Get Media Asset by ID:
+
+Use the `getMediaAssetById` method to retrieve a specific media asset by its ID. Provide `mediaId`of the asset to fetch its details. Refer to the [Get a media by ID](./docs/VideoOnDemand/ManageMedia.md#method-getmediaassetbyid) API documentation for more details.
+
+```javascript
+// Define the parameter for fetching a specific media asset by ID.
+const mediaQueryParams = {
+  mediaId: "media-id", // Unique identifier for the media asset to be retrieved
+};
+
+const getMediaAsset = await fastpix.getMediaAssetById(mediaQueryParams);
+console.log("Retrieved media asset by ID:", getMediaAsset);
+```
+
+#### Update Media Asset:
+
+Use the `updateMediaAsset` method to update metadata or other properties of a specific media asset. Provide the `mediaId` of the asset along with the metadata to be updated. Refer to the [Update a media by ID](./docs/VideoOnDemand/ManageMedia.md#method-updatemediaasset) API documentation for more details.
+
+```javascript
+// Define the parameter for specifying the media asset to be updated.
+const mediaAssetToUpdate = {
+  mediaId: "media-id", // Unique identifier for the media asset to update.
+};
+
+// Define the payload with the updates to be applied to the media asset.
+const updatePayload = {
+  metadata: {
+    "key": "value", // Replace "key" and "value" with actual metadata entries.
+    "category": "nature" // Example of another metadata entry.
+  },
+};
+
+const updateMediaAsset = await fastpix.updateMediaAsset(
+  mediaAssetToUpdate,
+  updatePayload
+);
+console.log("Updated Media Asset:", updateMediaAsset);
+```
+
+#### Delete Media Asset:
+
+Use the `deleteMediaAsset` method to delete a specific media asset by its ID. Pass the `mediaId` of the asset you want to delete. Refer to the [Delete a media by ID](./docs/VideoOnDemand/ManageMedia.md#method-deletemediaasset) API documentation for more information.
+
+```javascript
+// Define the parameter for specifying the media asset to be deleted.
+const mediaAssetToDelete = {
+  mediaId: "media-id", // Unique identifier for the media asset to delete.
+};
+
+const deleteMediaAsset = await fastpix.deleteMediaAsset(mediaAssetToDelete);
+console.log("Deleted Media Asset:", deleteMediaAsset);
+```
+
+#### Get Media Asset Info:
+
+Use the `getMediaAssetInfo` method to retrieve detailed information about a specific media asset. Pass the `mediaId` to fetch its details. Refer to the [Get info of media inputs](./docs/VideoOnDemand/ManageMedia.md#method-getmediaassetinfo) API documentation for more details.
+
+```javascript
+// Define the parameter for specifying the media asset whose info is to be retrieved.
+const mediaInfoRequest = {
+  mediaId: "media-id", // Unique identifier for the media asset.
+};
+
+const getMediaInfo = await fastpix.getMediaAssetInfo(mediaInfoRequest);
+console.log("Media Asset Info:", getMediaInfo);
+```
+
+### 1.3. Manage Media Playback:
+
+#### Generate Media Playback ID:
+
+Use the `generateMediaPlaybackId` method to generate a playback ID for a specific media asset. You can pass an `mediaId` and configure options such as the `accessPolicy`. For detailed configuration options, refer to the [Create a playback ID](./docs/VideoOnDemand/ManageMediaPlayback.md#method-generatemediaplaybackid) API documentation.
+
+```javascript
+// Define the mediaId and accessPolicy dynamically
+const mediaPlaybackRequest = {
+  mediaId: "media-id", // Unique identifier for the media asset.
+};
+
+const playbackOptions = {
+  accessPolicy: "public", // Can be 'public' or 'private'.
+};
+
+const playbackIdResponse = await fastpix.generateMediaPlaybackId(
+  mediaPlaybackRequest, // Pass the mediaId
+  playbackOptions // Pass the accessPolicy
+);
+
+console.log("Playback ID Creation Response:", playbackIdResponse);
+```
+
+#### Delete Media Playback ID:
+
+Use the `deleteMediaPlaybackId` method to delete one or more playback IDs associated with a specific media asset. This method allows you to specify both the `mediaId` and the `playbackId` you wish to delete. This method supports deleting a **single playback ID** as a string or **multiple playback IDs** as an array of strings. For detailed configuration options, refer to the [Delete a playback ID](./docs/VideoOnDemand/ManageMediaPlayback.md#method-deletemediaplaybackid) API documentation.
+
+```javascript
+const mediaId = "media-id"; // The ID of the media asset for which you want to delete the playback ID.
+const playbackId = "playback-id"; // For deleting a single playback ID as a string.
+
+// Example for multiple playback IDs:
+// const playbackId = ["playback-id-1", "playback-id-2"]; // Pass an array of playback IDs to delete.
+
+// Use the deleteMediaPlaybackId method to delete the specified playback ID(s).
+const deletePlaybackResponse = await fastpix.deleteMediaPlaybackId({
+  mediaId: mediaId,     // Pass the mediaId for which playback ID(s) are to be deleted
+  playbackId: playbackId, // Pass the playbackId(s) to delete. 
+});
+
+console.log("Playback ID Deletion Response:", deletePlaybackResponse);
+```
+
+---
+
+## 2. Live Stream Operations:
+
+### 2.1. Start Live Stream:
+
+Use the `initiateLiveStream` method to start a live stream with specific configurations. For detailed configuration options, refer to the [Create a new stream](./docs/Live/CreateLiveStream.md#method-initiatelivestream) API documentation.
+
+```javascript
+const liveStreamRequest = {
+  playbackSettings: {
+    accessPolicy: "public", // Defines the access level of the live stream (public or private)
+  },
+  inputMediaSettings: {
+    maxResolution: "1080p", // Set the maximum resolution of the live stream
+    reconnectWindow: 1800, // Set the duration for reconnecting the stream in seconds
+    mediaPolicy: "private", // Define media policy (private or public)
+    metadata: {
+      liveStream: "fp_livestream", // Custom metadata for the live stream
+    },
+    enableDvrMode: true, // Enable DVR mode to allow viewers to rewind the live stream
+  },
+};
+
+// Initiating the live stream
+const generateLiveStream = await fastpix.initiateLiveStream(liveStreamRequest);
+console.log("Live Stream initiated successfully:", generateLiveStream);
+```
+
+### 2.2. Live Stream Management:
+
+#### Get List of All Live Streams:
+
+Use the `getAllLiveStreams` method to fetch a list of all live streams. You can customize the query by modifying parameters such as `limit`, `offset`, and `orderBy`. For detailed configuration options, refer to the [Get all live streams](./docs/Live/ManageLiveStreams.md#method-getalllivestreams) API documentation.
+
+```javascript
+const getAllLiveStreamPagination = {
+  limit: 10, // Limit the number of live streams retrieved.
+  offset: 1, // Skip a specified number of streams for pagination.
+  orderBy: "asc", // Order the results based on the specified criteria ("asc" or "desc").
+};
+
+const getAllLiveStreams = await fastpix.getAllLiveStreams(
+  getAllLiveStreamPagination
+);
+console.log("All Live Streams:", getAllLiveStreams);
+```
+
+#### Get Live Stream by ID:
+
+Use the `getLiveStreamById` method to retrieve a specific live stream by its ID. Provide the `streamId` of the stream you wish to fetch. For more details, refer to the [Get stream by ID](./docs/Live/ManageLiveStreams.md#method-getlivestreambyid) API documentation.
+
+```javascript
+const getLiveStreamById = await fastpix.getLiveStreamById({
+  streamId: "a09f3e958c16ed00e85bfe798abd9845", // Replace with actual stream ID
+});
+
+console.log("Live Stream Details:", getLiveStreamById);
+```
+
+#### Update Live Stream:
+
+Use the `updateLiveStream` method to update a live stream's configuration. Provide the `streamId` of the stream and specify the fields you want to update. For more details, refer to the [Update a stream](./docs/Live/ManageLiveStreams.md#method-updatelivestream) API documentation.
+
+```javascript
+const updateLiveStreamRequest = {
+  metadata: {
+    livestream_name: "Game_streaming",
+  },
+  reconnectWindow: 100,
+};
+
+const updateLiveStream = await fastpix.updateLiveStream(
+  { streamId: "a09f3e958c16ed00e85bfe798abd9845" }, // Provide the stream ID for the live stream to update
+  updateLiveStreamRequest
+);
+
+console.log("Updated Live Stream:", updateLiveStream);
+```
+
+#### Delete Live Stream:
+
+Use the `deleteLiveStream` method to delete a live stream by its ID. Provide `streamId` of the stream you want to delete. For more details, refer to the [Delete a stream](./docs/Live/ManageLiveStreams.md#method-deletelivestream) API documentation.
+
+```javascript
+const deleteLiveStream = await fastpix.deleteLiveStream({
+  streamId: "a09f3e958c16ed00e85bfe798abd9845", // Provide the stream ID of the live stream to delete
+});
+console.log("Deleted Live Stream:", deleteLiveStream);
+```
+
+### 2.3. Manage Live Stream Playback:
+
+#### Generate Live Stream Playback ID:
+
+Use the `generateLiveStreamPlaybackId` method to generate a playback ID for a live stream. Replace `streamId` with the actual ID of the live stream and specify the desired `accessPolicy`. For more details, refer to the [Create a playback ID](./docs/Live/ManageStreamPlayback.md#method-generatelivestreamplaybackid) API documentation.
+
+```javascript
+const generateLiveStreamPlaybackId = await fastpix.generateLiveStreamPlaybackId(
+  { streamId: "a09f3e958c16ed00e85bfe798abd9845" }, // Pass the stream ID for which the playback ID is to be generated
+  { accessPolicy: "public" } // This can be "public" or "private" based on your needs
+);
+
+console.log("Generated Live Stream Playback ID:", generateLiveStreamPlaybackId);
+```
+
+#### Delete Live Stream Playback ID:
+
+Use the `deleteLiveStreamPlaybackId` method to remove one or more playback IDs associated with a live stream. This method allows you to specify the `streamId` of the live stream, and the `playbackId` you wish to delete. This method supports deleting a **single playback ID** as a string or **multiple playback IDs** as an array of strings. For more details, refer to the [Delete a playback ID](./docs/Live/ManageStreamPlayback.md#method-deletelivestreamplaybackid) API documentation.
+
+```javascript
+// Define the streamId and playbackId dynamically
+const streamId = "a09f3e958c16ed00e85bfe798abd9845";
+
+// For single playbackId, pass it as a string
+const playbackId = "632029b4-7c53-4dcf-a4d3-1884c29e90f8"; 
+
+// For multiple playbackId's, pass them as an array of strings
+// const playbackId = ["632029b4-7c53-4dcf-a4d3-1884c29e90f8", "687629b4-7c53-4dcf-a4d3-1884876540f8"]; 
+
+const deleteLiveStreamPlaybackId = await fastpix.deleteLiveStreamPlaybackId({
+  streamId: streamId, // Pass the streamId of the live stream for which playback ID is to be deleted
+  playbackId: playbackId, // Pass the playbackId as an array (even for a single ID)
+});
+
+console.log("Deleted Live Stream Playback ID:", deleteLiveStreamPlaybackId);
+```
+
+#### Get Live Stream Playback Policy:
+
+Use the `getLiveStreamPlaybackPolicy` method to retrieve the playback policy for a specific live stream playback ID. Replace `streamId` with the stream's ID and `playbackId` with the actual playback ID to fetch the policy. For more details, refer to the [Get stream's playback ID](./docs/Live/ManageStreamPlayback.md#method-getlivestreamplaybackpolicy) API documentation.
+
+```javascript
+const getLiveStreamPlaybackPolicy = await fastpix.getLiveStreamPlaybackPolicy({
+  streamId: "1c5e8abcc2080cba74f5d0ac91c7833e", // Replace with the actual stream ID
+  playbackId: "95ce872d-0b58-44f3-be72-8ed8b97ee2c9", // Replace with the actual playback ID
+});
+
+console.log("Live Stream Playback Policy:", getLiveStreamPlaybackPolicy);
+```
+
+### 2.4. Manage Live Stream Simulcast:
+
+#### Initiate Live Stream Simulcast:
+
+Use the `initiateLiveStreamSimulcast` method to create a new simulcast for a live stream. Provide the stream ID and simulcast payload with the URL and stream key. For more details, refer to the [Create a simulcast](./docs/Live/ManageStreamSimulcast.md#method-initiatelivestreamsimulcast) API documentation.
+
+```javascript
+const simulcastPayload = {
+  url: "rtmps://live.fastpix.io:443/live",
+  streamKey:
+    "46c3457fa8a579b2d4da64125a2b6e83ka09f3e958c16ed00e85bfe798abd9845", // Replace with actual stream key
+};
+
+const generateSimulcast = await fastpix.initiateLiveStreamSimulcast(
+  {
+    streamId: "a09f3e958c16ed00e85bfe798abd9845", // Replace with actual stream ID
+  },
+  simulcastPayload
+);
+
+console.log("Generate Simulcast:", generateSimulcast);
+```
+
+#### Get Live Stream Simulcast:
+
+Use the `getLiveStreamSimulcast` method to retrieve details of a specific simulcast stream. Provide the `streamId` and `simulcastId` of the simulcast you want to fetch. For more details, refer to the [Get a specific simulcast of a stream](./docs/Live/ManageStreamSimulcast.md#method-getlivestreamsimulcast) API documentation.
+
+```javascript
+const getLiveSimulcast = await fastpix.getLiveStreamSimulcast({
+  streamId: "a09f3e958c16ed00e85bfe798abd9845", // Replace with actual stream ID
+  simulcastId: "7269209ff0299319b6321c9a6e7850ff", // Replace with actual simulcast ID
+});
+
+console.log("Live Stream Simulcast Details:", getLiveSimulcast);
+```
+
+#### Update Live Stream Simulcast:
+
+Use the `updateLiveStreamSimulcast` method to update the configuration of a simulcast stream. Provide the `streamId`, `simulcastId`, and the fields you want to update. For more details, refer to the [Update a specific simulcast of a stream](./docs/Live/ManageStreamSimulcast.md#method-updatelivestreamsimulcast) API documentation.
+
+```javascript
+const updateLiveSimulcast = await fastpix.updateLiveStreamSimulcast(
+  {
+    streamId: "a09f3e958c16ed00e85bfe798abd9845", // Replace with actual stream ID
+    simulcastId: "7269209ff0299319b6321c9a6e7850ff", // Replace with actual simulcast ID
+  },
+  {
+    isEnabled: false, // Disable the simulcast stream (set to true to enable)
+    metadata: {
+      simulcast2: "media", // Update the metadata as needed
+    },
+  }
+);
+
+console.log("Updated Live Stream Simulcast:", updateLiveSimulcast);
+```
+
+#### Delete Live Stream Simulcast:
+
+Use the `deleteLiveStreamSimulcast` method to remove a specific simulcast from a live stream. Provide the `streamId` and `simulcastId` for the simulcast you want to delete. For more details, refer to the [Delete a simulcast](./docs/Live/ManageStreamSimulcast.md#method-deletelivestreamsimulcast) API documentation.
+
+```javascript
+const deleteLiveSimulcast = await fastpix.deleteLiveStreamSimulcast({
+  streamId: "a09f3e958c16ed00e85bfe798abd9845", // Replace with actual stream ID
+  simulcastId: "7269209ff0299319b6321c9a6e7850ff", // Replace with actual simulcast ID
+});
+
+console.log("Deleted Live Stream Simulcast:", deleteLiveSimulcast);
+```
+
+## Detailed Usage:
+
+For a complete understanding of each API's functionality, including request and response details, parameter descriptions, and additional examples, please refer to the [FastPix API Reference](https://docs.fastpix.io/reference/signingkeys-overview).
+
+The API reference provides comprehensive documentation for all available endpoints and features, ensuring developers can integrate and utilize FastPix APIs efficiently.

package/dist/Live/index.d.ts

@@ -0,0 +1,19 @@
+import type { AccessPolicy, RequestObject, InitiateLiveStreamProps, LiveStreamProps, PaginationProps, SimulcastObject, SimulcastProps, UpdateObject, UpdateSimulcastProps, FetcherProps } from "../../types";
+declare class LiveStream {
+    livePath: string;
+    fetch: FetcherProps;
+    constructor();
+    createNewLiveStream(props: InitiateLiveStreamProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    getAllLiveStreams(props?: PaginationProps, requestObj?: RequestObject): Promise<import("../../types").FetchResponse>;
+    getLiveStream(props: LiveStreamProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    updateLiveStream(props: LiveStreamProps, updateObject: UpdateObject, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    deleteLiveStream(props: LiveStreamProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    createLiveStreamPlaybackId(props: LiveStreamProps, playbackPolicy: AccessPolicy, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    removeLivePlaybackId(props: LiveStreamProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    getLiveStreamPlaybackPolicy(props: LiveStreamProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    createLiveStreamSimulcast(props: LiveStreamProps, liveStreamObj: SimulcastObject, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    getLiveStreamSimulcast(props: SimulcastProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    updateLiveStreamSimulcast(props: SimulcastProps, simulcastObj: UpdateSimulcastProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+    deleteLiveStreamSimulcast(props: SimulcastProps, requestObj: RequestObject): Promise<import("../../types").FetchResponse>;
+}
+export default LiveStream;