@stack0/sdk 0.5.7 → 0.5.8

package/dist/cdn/index.d.mts

@@ -306,6 +306,52 @@ interface ExtractAudioResponse {
     jobId: string;
     status: TranscodingStatus;
 }
+type GifStatus = "pending" | "processing" | "completed" | "failed";
+interface GenerateGifRequest {
+    /** Project slug */
+    projectSlug: string;
+    /** ID of the video asset to generate GIF from */
+    assetId: string;
+    /** Start time in seconds (default: 0) */
+    startTime?: number;
+    /** Duration in seconds (0.5-30, default: 5) */
+    duration?: number;
+    /** Output width in pixels (100-800, default: 480) */
+    width?: number;
+    /** Frames per second (5-30, default: 10) */
+    fps?: number;
+    /** Use two-pass palette optimization for smaller file size (default: true) */
+    optimizePalette?: boolean;
+}
+interface VideoGif {
+    id: string;
+    assetId: string;
+    /** Start time in seconds */
+    startTime: number;
+    /** Duration in seconds */
+    duration: number;
+    /** Frames per second */
+    fps: number;
+    /** CDN URL of the generated GIF (null if pending/processing) */
+    url: string | null;
+    /** Width in pixels */
+    width: number | null;
+    /** Height in pixels */
+    height: number | null;
+    /** File size in bytes */
+    sizeBytes: number | null;
+    /** Number of frames in the GIF */
+    frameCount: number | null;
+    /** Current status of the GIF generation */
+    status: GifStatus;
+    /** Error message if failed */
+    errorMessage: string | null;
+    createdAt: Date;
+    completedAt: Date | null;
+}
+interface ListGifsRequest {
+    assetId: string;
+}
 type PrivateFileStatus = "pending" | "ready" | "failed" | "deleted";
 interface PrivateFile {
     id: string;
@@ -1033,6 +1079,60 @@ declare class CDN {
      * ```
      */
     extractAudio(request: ExtractAudioRequest): Promise<ExtractAudioResponse>;
+    /**
+     * Generate an animated GIF from a video segment
+     *
+     * Creates an optimized GIF from a portion of the video. Uses two-pass
+     * palette generation by default for smaller file sizes with better quality.
+     *
+     * @example
+     * ```typescript
+     * const gif = await cdn.generateGif({
+     *   projectSlug: 'my-project',
+     *   assetId: 'video-asset-id',
+     *   startTime: 5,      // Start at 5 seconds
+     *   duration: 3,       // 3 second GIF
+     *   width: 480,        // 480px wide
+     *   fps: 10,           // 10 frames per second
+     * });
+     *
+     * // Poll for completion
+     * let result = await cdn.getGif(gif.id);
+     * while (result?.status === 'pending' || result?.status === 'processing') {
+     *   await new Promise(r => setTimeout(r, 1000));
+     *   result = await cdn.getGif(gif.id);
+     * }
+     *
+     * console.log(`GIF URL: ${result?.url}`);
+     * ```
+     */
+    generateGif(request: GenerateGifRequest): Promise<VideoGif>;
+    /**
+     * Get a specific GIF by ID
+     *
+     * @example
+     * ```typescript
+     * const gif = await cdn.getGif('gif-id');
+     * if (gif?.status === 'completed') {
+     *   console.log(`GIF URL: ${gif.url}`);
+     *   console.log(`Size: ${gif.sizeBytes} bytes`);
+     * }
+     * ```
+     */
+    getGif(gifId: string): Promise<VideoGif | null>;
+    /**
+     * List all GIFs generated for a video asset
+     *
+     * @example
+     * ```typescript
+     * const gifs = await cdn.listGifs({ assetId: 'video-asset-id' });
+     * for (const gif of gifs) {
+     *   console.log(`GIF at ${gif.startTime}s: ${gif.url}`);
+     * }
+     * ```
+     */
+    listGifs(request: ListGifsRequest): Promise<VideoGif[]>;
+    private convertGifDates;
     private convertJobDates;
     /**
      * Generate a presigned URL for uploading a private file
@@ -1383,4 +1483,4 @@ declare class CDN {
     private convertMergeJobWithOutputDates;
 }
 
-export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };
+export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GenerateGifRequest, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type GifStatus, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };

package/dist/cdn/index.d.ts

@@ -306,6 +306,52 @@ interface ExtractAudioResponse {
     jobId: string;
     status: TranscodingStatus;
 }
+type GifStatus = "pending" | "processing" | "completed" | "failed";
+interface GenerateGifRequest {
+    /** Project slug */
+    projectSlug: string;
+    /** ID of the video asset to generate GIF from */
+    assetId: string;
+    /** Start time in seconds (default: 0) */
+    startTime?: number;
+    /** Duration in seconds (0.5-30, default: 5) */
+    duration?: number;
+    /** Output width in pixels (100-800, default: 480) */
+    width?: number;
+    /** Frames per second (5-30, default: 10) */
+    fps?: number;
+    /** Use two-pass palette optimization for smaller file size (default: true) */
+    optimizePalette?: boolean;
+}
+interface VideoGif {
+    id: string;
+    assetId: string;
+    /** Start time in seconds */
+    startTime: number;
+    /** Duration in seconds */
+    duration: number;
+    /** Frames per second */
+    fps: number;
+    /** CDN URL of the generated GIF (null if pending/processing) */
+    url: string | null;
+    /** Width in pixels */
+    width: number | null;
+    /** Height in pixels */
+    height: number | null;
+    /** File size in bytes */
+    sizeBytes: number | null;
+    /** Number of frames in the GIF */
+    frameCount: number | null;
+    /** Current status of the GIF generation */
+    status: GifStatus;
+    /** Error message if failed */
+    errorMessage: string | null;
+    createdAt: Date;
+    completedAt: Date | null;
+}
+interface ListGifsRequest {
+    assetId: string;
+}
 type PrivateFileStatus = "pending" | "ready" | "failed" | "deleted";
 interface PrivateFile {
     id: string;
@@ -1033,6 +1079,60 @@ declare class CDN {
      * ```
      */
     extractAudio(request: ExtractAudioRequest): Promise<ExtractAudioResponse>;
+    /**
+     * Generate an animated GIF from a video segment
+     *
+     * Creates an optimized GIF from a portion of the video. Uses two-pass
+     * palette generation by default for smaller file sizes with better quality.
+     *
+     * @example
+     * ```typescript
+     * const gif = await cdn.generateGif({
+     *   projectSlug: 'my-project',
+     *   assetId: 'video-asset-id',
+     *   startTime: 5,      // Start at 5 seconds
+     *   duration: 3,       // 3 second GIF
+     *   width: 480,        // 480px wide
+     *   fps: 10,           // 10 frames per second
+     * });
+     *
+     * // Poll for completion
+     * let result = await cdn.getGif(gif.id);
+     * while (result?.status === 'pending' || result?.status === 'processing') {
+     *   await new Promise(r => setTimeout(r, 1000));
+     *   result = await cdn.getGif(gif.id);
+     * }
+     *
+     * console.log(`GIF URL: ${result?.url}`);
+     * ```
+     */
+    generateGif(request: GenerateGifRequest): Promise<VideoGif>;
+    /**
+     * Get a specific GIF by ID
+     *
+     * @example
+     * ```typescript
+     * const gif = await cdn.getGif('gif-id');
+     * if (gif?.status === 'completed') {
+     *   console.log(`GIF URL: ${gif.url}`);
+     *   console.log(`Size: ${gif.sizeBytes} bytes`);
+     * }
+     * ```
+     */
+    getGif(gifId: string): Promise<VideoGif | null>;
+    /**
+     * List all GIFs generated for a video asset
+     *
+     * @example
+     * ```typescript
+     * const gifs = await cdn.listGifs({ assetId: 'video-asset-id' });
+     * for (const gif of gifs) {
+     *   console.log(`GIF at ${gif.startTime}s: ${gif.url}`);
+     * }
+     * ```
+     */
+    listGifs(request: ListGifsRequest): Promise<VideoGif[]>;
+    private convertGifDates;
     private convertJobDates;
     /**
      * Generate a presigned URL for uploading a private file
@@ -1383,4 +1483,4 @@ declare class CDN {
     private convertMergeJobWithOutputDates;
 }
 
-export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };
+export { type Asset, type AssetStatus, type AssetType, type AudioTrackInput, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type CancelMergeJobRequest, type CdnEnvironment, type CdnStorageBreakdownItem, type CdnStorageBreakdownRequest, type CdnStorageBreakdownResponse, type CdnUsageDataPoint, type CdnUsageHistoryRequest, type CdnUsageHistoryResponse, type CdnUsageRequest, type CdnUsageResponse, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type CreateMergeJobRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderListItem, type FolderTreeNode, type GenerateGifRequest, type GetAssetRequest, type GetFolderByPathRequest, type GetFolderRequest, type GetFolderTreeRequest, type GetMergeJobRequest, type GifStatus, type ImageWatermarkConfig, type ImageWatermarkPosition, type ImageWatermarkSizingMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListJobsRequest, type ListJobsResponse, type ListMergeJobsRequest, type ListMergeJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type ListThumbnailsRequest, type ListThumbnailsResponse, type MergeInputItem, type MergeJob, type MergeJobWithOutput, type MergeOutputConfig, type MergeOutputFormat, type MergeQuality, type MergeStatus, type MoveAssetsRequest, type MoveAssetsResponse, type MoveFolderRequest, type MoveFolderResponse, type MovePrivateFilesRequest, type MovePrivateFilesResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type TextOverlay, type TextOverlayShadow, type TextOverlayStroke, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdateFolderRequest, type UpdatePrivateFileRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };

package/dist/cdn/index.js

@@ -558,6 +558,80 @@ var CDN = class {
   async extractAudio(request) {
     return this.http.post("/cdn/video/extract-audio", request);
   }
+  // ============================================================================
+  // GIF Generation Methods
+  // ============================================================================
+  /**
+   * Generate an animated GIF from a video segment
+   *
+   * Creates an optimized GIF from a portion of the video. Uses two-pass
+   * palette generation by default for smaller file sizes with better quality.
+   *
+   * @example
+   * ```typescript
+   * const gif = await cdn.generateGif({
+   *   projectSlug: 'my-project',
+   *   assetId: 'video-asset-id',
+   *   startTime: 5,      // Start at 5 seconds
+   *   duration: 3,       // 3 second GIF
+   *   width: 480,        // 480px wide
+   *   fps: 10,           // 10 frames per second
+   * });
+   *
+   * // Poll for completion
+   * let result = await cdn.getGif(gif.id);
+   * while (result?.status === 'pending' || result?.status === 'processing') {
+   *   await new Promise(r => setTimeout(r, 1000));
+   *   result = await cdn.getGif(gif.id);
+   * }
+   *
+   * console.log(`GIF URL: ${result?.url}`);
+   * ```
+   */
+  async generateGif(request) {
+    const response = await this.http.post("/cdn/video/gif", request);
+    return this.convertGifDates(response);
+  }
+  /**
+   * Get a specific GIF by ID
+   *
+   * @example
+   * ```typescript
+   * const gif = await cdn.getGif('gif-id');
+   * if (gif?.status === 'completed') {
+   *   console.log(`GIF URL: ${gif.url}`);
+   *   console.log(`Size: ${gif.sizeBytes} bytes`);
+   * }
+   * ```
+   */
+  async getGif(gifId) {
+    const response = await this.http.get(`/cdn/video/gif/${gifId}`);
+    return response ? this.convertGifDates(response) : null;
+  }
+  /**
+   * List all GIFs generated for a video asset
+   *
+   * @example
+   * ```typescript
+   * const gifs = await cdn.listGifs({ assetId: 'video-asset-id' });
+   * for (const gif of gifs) {
+   *   console.log(`GIF at ${gif.startTime}s: ${gif.url}`);
+   * }
+   * ```
+   */
+  async listGifs(request) {
+    const response = await this.http.get(`/cdn/video/${request.assetId}/gifs`);
+    return response.map((gif) => this.convertGifDates(gif));
+  }
+  convertGifDates(gif) {
+    if (typeof gif.createdAt === "string") {
+      gif.createdAt = new Date(gif.createdAt);
+    }
+    if (gif.completedAt && typeof gif.completedAt === "string") {
+      gif.completedAt = new Date(gif.completedAt);
+    }
+    return gif;
+  }
   convertJobDates(job) {
     if (typeof job.createdAt === "string") {
       job.createdAt = new Date(job.createdAt);