@stack0/sdk 0.5.7 → 0.5.9

package/dist/cdn/index.d.ts

@@ -44,6 +44,15 @@ interface UploadUrlResponse {
     cdnUrl: string;
     expiresAt: Date;
 }
+interface UploadFromUrlRequest {
+    projectSlug: string;
+    /** URL to fetch the file from */
+    sourceUrl: string;
+    filename: string;
+    mimeType: string;
+    folder?: string;
+    metadata?: Record<string, unknown>;
+}
 interface ConfirmUploadRequest {
     assetId: string;
 }
@@ -216,6 +225,8 @@ interface ImageWatermarkConfig {
     tile?: boolean;
     /** Spacing between tiles when tile is true (pixels, default: 100) */
     tileSpacing?: number;
+    /** Corner radius in pixels (0-500, default: 0) */
+    borderRadius?: number;
 }
 interface TrimOptions {
     start: number;
@@ -306,6 +317,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;
@@ -714,6 +771,177 @@ interface ListMergeJobsResponse {
     total: number;
     hasMore: boolean;
 }
+type ImportJobStatus = "pending" | "validating" | "importing" | "completed" | "failed" | "cancelled";
+type ImportAuthType = "iam_credentials" | "role_assumption";
+type ImportPathMode = "preserve" | "flatten";
+type ImportFileStatus = "pending" | "importing" | "completed" | "failed" | "skipped";
+/**
+ * Error recorded during import
+ */
+interface ImportError {
+    key: string;
+    error: string;
+    timestamp: string;
+}
+/**
+ * Request to create an S3 import job
+ */
+interface CreateImportRequest {
+    projectSlug: string;
+    environment?: CdnEnvironment;
+    /** Source S3 bucket name */
+    sourceBucket: string;
+    /** AWS region of the source bucket */
+    sourceRegion: string;
+    /** Optional prefix to filter source files */
+    sourcePrefix?: string;
+    /** Authentication method */
+    authType: ImportAuthType;
+    /** AWS access key ID (required for iam_credentials auth) */
+    accessKeyId?: string;
+    /** AWS secret access key (required for iam_credentials auth) */
+    secretAccessKey?: string;
+    /** IAM role ARN (required for role_assumption auth) */
+    roleArn?: string;
+    /** External ID for role assumption */
+    externalId?: string;
+    /** How to handle source paths (flatten: use filename only, preserve: keep path structure) */
+    pathMode?: ImportPathMode;
+    /** Target folder for imported assets */
+    targetFolder?: string;
+    /** Email address for completion notification */
+    notifyEmail?: string;
+}
+/**
+ * Response from creating an import job
+ */
+interface CreateImportResponse {
+    importId: string;
+    status: ImportJobStatus;
+    sourceBucket: string;
+    sourceRegion: string;
+    sourcePrefix: string | null;
+    createdAt: Date;
+}
+/**
+ * Import job details
+ */
+interface ImportJob {
+    id: string;
+    organizationId: string;
+    projectId: string;
+    environment: CdnEnvironment;
+    sourceBucket: string;
+    sourceRegion: string;
+    sourcePrefix: string | null;
+    authType: ImportAuthType;
+    pathMode: ImportPathMode;
+    targetFolder: string | null;
+    status: ImportJobStatus;
+    totalFiles: number;
+    processedFiles: number;
+    skippedFiles: number;
+    failedFiles: number;
+    totalBytes: number;
+    processedBytes: number;
+    errors: ImportError[] | null;
+    notifyEmail: string | null;
+    startedAt: Date | null;
+    completedAt: Date | null;
+    createdAt: Date;
+    updatedAt: Date | null;
+}
+/**
+ * Request to list import jobs
+ */
+interface ListImportsRequest {
+    projectSlug: string;
+    environment?: CdnEnvironment;
+    status?: ImportJobStatus;
+    sortBy?: "createdAt" | "status" | "totalFiles";
+    sortOrder?: "asc" | "desc";
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Import job summary for list responses
+ */
+interface ImportJobSummary {
+    id: string;
+    sourceBucket: string;
+    sourceRegion: string;
+    sourcePrefix: string | null;
+    status: ImportJobStatus;
+    totalFiles: number;
+    processedFiles: number;
+    skippedFiles: number;
+    failedFiles: number;
+    totalBytes: number;
+    processedBytes: number;
+    startedAt: Date | null;
+    completedAt: Date | null;
+    createdAt: Date;
+}
+/**
+ * Response from listing import jobs
+ */
+interface ListImportsResponse {
+    imports: ImportJobSummary[];
+    total: number;
+    hasMore: boolean;
+}
+/**
+ * Response from cancelling an import job
+ */
+interface CancelImportResponse {
+    success: boolean;
+    status: ImportJobStatus;
+}
+/**
+ * Response from retrying failed files
+ */
+interface RetryImportResponse {
+    success: boolean;
+    retriedCount: number;
+    status: ImportJobStatus;
+}
+/**
+ * Request to list files in an import job
+ */
+interface ListImportFilesRequest {
+    importId: string;
+    status?: ImportFileStatus;
+    sortBy?: "createdAt" | "sourceKey" | "sourceSize" | "status";
+    sortOrder?: "asc" | "desc";
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Individual file within an import job
+ */
+interface ImportFile {
+    id: string;
+    importJobId: string;
+    sourceKey: string;
+    sourceSize: number;
+    sourceMimeType: string | null;
+    sourceEtag: string | null;
+    assetId: string | null;
+    status: ImportFileStatus;
+    errorMessage: string | null;
+    retryCount: number;
+    lastAttemptAt: Date | null;
+    createdAt: Date;
+    completedAt: Date | null;
+}
+/**
+ * Response from listing import files
+ */
+interface ListImportFilesResponse {
+    files: ImportFile[];
+    total: number;
+    hasMore: boolean;
+}
 
 /**
  * Stack0 CDN Client
@@ -790,6 +1018,24 @@ declare class CDN {
         /** Watermark configuration for images (applied during upload processing) */
         watermark?: ImageWatermarkConfig;
     }): Promise<Asset>;
+    /**
+     * Upload a file from a remote URL (server-side fetch).
+     * The server streams the file directly from the source URL into storage,
+     * so the client never touches the bytes. Ideal for serverless environments
+     * with tight memory limits.
+     *
+     * @example
+     * ```typescript
+     * const asset = await cdn.uploadFromUrl({
+     *   projectSlug: 'my-project',
+     *   sourceUrl: 'https://replicate.delivery/output/video.mp4',
+     *   filename: 'video.mp4',
+     *   mimeType: 'video/mp4',
+     * });
+     * console.log(asset.cdnUrl);
+     * ```
+     */
+    uploadFromUrl(request: UploadFromUrlRequest): Promise<Asset>;
     /**
      * Get an asset by ID
      *
@@ -1033,6 +1279,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
@@ -1381,6 +1681,121 @@ declare class CDN {
     }>;
     private convertMergeJobDates;
     private convertMergeJobWithOutputDates;
+    /**
+     * Create an S3 import job to bulk import files from an external S3 bucket.
+     * Requires Pro plan or higher.
+     *
+     * @example
+     * ```typescript
+     * // Using IAM credentials
+     * const job = await cdn.createImport({
+     *   projectSlug: 'my-project',
+     *   sourceBucket: 'my-external-bucket',
+     *   sourceRegion: 'us-east-1',
+     *   sourcePrefix: 'images/',
+     *   authType: 'iam_credentials',
+     *   accessKeyId: 'AKIA...',
+     *   secretAccessKey: 'secret...',
+     *   pathMode: 'flatten',
+     *   notifyEmail: 'admin@example.com',
+     * });
+     *
+     * // Using role assumption
+     * const job = await cdn.createImport({
+     *   projectSlug: 'my-project',
+     *   sourceBucket: 'partner-bucket',
+     *   sourceRegion: 'eu-west-1',
+     *   authType: 'role_assumption',
+     *   roleArn: 'arn:aws:iam::123456789012:role/Stack0ImportRole',
+     *   externalId: 'optional-external-id',
+     *   pathMode: 'preserve',
+     *   targetFolder: '/imported',
+     * });
+     *
+     * console.log(`Import job started: ${job.importId}`);
+     * ```
+     */
+    createImport(request: CreateImportRequest): Promise<CreateImportResponse>;
+    /**
+     * Get an import job by ID
+     *
+     * @example
+     * ```typescript
+     * const job = await cdn.getImport('import-id');
+     * console.log(`Status: ${job.status}`);
+     * console.log(`Progress: ${job.processedFiles}/${job.totalFiles} files`);
+     * console.log(`Bytes: ${job.processedBytes}/${job.totalBytes}`);
+     * ```
+     */
+    getImport(importId: string): Promise<ImportJob | null>;
+    /**
+     * List import jobs with pagination and filters
+     *
+     * @example
+     * ```typescript
+     * const { imports, total, hasMore } = await cdn.listImports({
+     *   projectSlug: 'my-project',
+     *   status: 'importing',
+     *   limit: 20,
+     * });
+     *
+     * for (const job of imports) {
+     *   console.log(`${job.sourceBucket}: ${job.processedFiles}/${job.totalFiles}`);
+     * }
+     * ```
+     */
+    listImports(request: ListImportsRequest): Promise<ListImportsResponse>;
+    /**
+     * Cancel a running import job
+     *
+     * Files already imported will remain. Only pending/validating/importing jobs can be cancelled.
+     *
+     * @example
+     * ```typescript
+     * const result = await cdn.cancelImport('import-id');
+     * console.log(`Cancelled: ${result.success}`);
+     * ```
+     */
+    cancelImport(importId: string): Promise<CancelImportResponse>;
+    /**
+     * Retry failed files in a completed or failed import job
+     *
+     * This resets failed files to pending and re-queues the import for processing.
+     *
+     * @example
+     * ```typescript
+     * const result = await cdn.retryImport('import-id');
+     * console.log(`Retrying ${result.retriedCount} files`);
+     * ```
+     */
+    retryImport(importId: string): Promise<RetryImportResponse>;
+    /**
+     * List files in an import job with optional status filter
+     *
+     * @example
+     * ```typescript
+     * // List all files
+     * const { files, total } = await cdn.listImportFiles({
+     *   importId: 'import-id',
+     *   limit: 100,
+     * });
+     *
+     * // List only failed files
+     * const { files: failedFiles } = await cdn.listImportFiles({
+     *   importId: 'import-id',
+     *   status: 'failed',
+     * });
+     *
+     * for (const file of failedFiles) {
+     *   console.log(`${file.sourceKey}: ${file.errorMessage}`);
+     * }
+     * ```
+     */
+    listImportFiles(request: ListImportFilesRequest): Promise<ListImportFilesResponse>;
+    private convertCreateImportDates;
+    private convertImportJobDates;
+    private convertImportJobSummaryDates;
+    private convertImportFileDates;
 }
 
-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 CancelImportResponse, 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 CreateImportRequest, type CreateImportResponse, 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 ImportAuthType, type ImportError, type ImportFile, type ImportFileStatus, type ImportJob, type ImportJobStatus, type ImportJobSummary, type ImportPathMode, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListFoldersRequest, type ListFoldersResponse, type ListGifsRequest, type ListImportFilesRequest, type ListImportFilesResponse, type ListImportsRequest, type ListImportsResponse, 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 RetryImportResponse, 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 UploadFromUrlRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoGif, type VideoOutputFormat, type VideoQuality, type VideoThumbnail, type VideoVariant, type WatermarkOptions };