@stack0/sdk 0.4.0 → 0.5.2

package/dist/cdn/index.d.mts

@@ -260,6 +260,116 @@ interface ExtractAudioResponse {
     jobId: string;
     status: TranscodingStatus;
 }
+type PrivateFileStatus = "pending" | "ready" | "failed" | "deleted";
+interface PrivateFile {
+    id: string;
+    filename: string;
+    originalFilename: string;
+    mimeType: string;
+    size: number;
+    s3Key: string;
+    folder: string | null;
+    description: string | null;
+    tags: string[] | null;
+    metadata: Record<string, unknown> | null;
+    status: PrivateFileStatus;
+    createdAt: Date;
+    updatedAt: Date | null;
+}
+interface PrivateUploadUrlRequest {
+    projectSlug: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    folder?: string;
+    description?: string;
+    metadata?: Record<string, unknown>;
+}
+interface PrivateUploadUrlResponse {
+    uploadUrl: string;
+    fileId: string;
+    expiresAt: Date;
+}
+interface PrivateDownloadUrlRequest {
+    fileId: string;
+    /** Expiration time in seconds (default: 3600, min: 3600, max: 604800) */
+    expiresIn?: number;
+}
+interface PrivateDownloadUrlResponse {
+    downloadUrl: string;
+    expiresAt: Date;
+}
+interface ListPrivateFilesRequest {
+    projectSlug: string;
+    folder?: string | null;
+    status?: PrivateFileStatus;
+    search?: string;
+    sortBy?: "createdAt" | "filename" | "size";
+    sortOrder?: "asc" | "desc";
+    limit?: number;
+    offset?: number;
+}
+interface ListPrivateFilesResponse {
+    files: PrivateFile[];
+    total: number;
+    hasMore: boolean;
+}
+interface UpdatePrivateFileRequest {
+    fileId: string;
+    description?: string;
+    folder?: string | null;
+    tags?: string[];
+    metadata?: Record<string, unknown>;
+}
+type BundleStatus = "pending" | "processing" | "ready" | "failed" | "expired";
+interface DownloadBundle {
+    id: string;
+    name: string;
+    description: string | null;
+    assetIds: string[] | null;
+    privateFileIds: string[] | null;
+    s3Key: string | null;
+    size: number | null;
+    fileCount: number | null;
+    status: BundleStatus;
+    error: string | null;
+    expiresAt: Date | null;
+    createdAt: Date;
+    completedAt: Date | null;
+}
+interface CreateBundleRequest {
+    projectSlug: string;
+    name: string;
+    description?: string;
+    assetIds?: string[];
+    privateFileIds?: string[];
+    /** Expiration time in seconds (default: 86400, min: 3600, max: 604800) */
+    expiresIn?: number;
+}
+interface CreateBundleResponse {
+    bundle: DownloadBundle;
+}
+interface ListBundlesRequest {
+    projectSlug: string;
+    status?: BundleStatus;
+    search?: string;
+    limit?: number;
+    offset?: number;
+}
+interface ListBundlesResponse {
+    bundles: DownloadBundle[];
+    total: number;
+    hasMore: boolean;
+}
+interface BundleDownloadUrlRequest {
+    bundleId: string;
+    /** Expiration time in seconds (default: 3600, min: 3600, max: 604800) */
+    expiresIn?: number;
+}
+interface BundleDownloadUrlResponse {
+    downloadUrl: string;
+    expiresAt: Date;
+}
 
 /**
  * Stack0 CDN Client
@@ -563,6 +673,158 @@ declare class CDN {
      */
     extractAudio(request: ExtractAudioRequest): Promise<ExtractAudioResponse>;
     private convertJobDates;
+    /**
+     * Generate a presigned URL for uploading a private file
+     *
+     * Private files are stored securely and can only be accessed through
+     * authorized download links with configurable expiration.
+     *
+     * @example
+     * ```typescript
+     * const { uploadUrl, fileId } = await cdn.getPrivateUploadUrl({
+     *   projectSlug: 'my-project',
+     *   filename: 'confidential.pdf',
+     *   mimeType: 'application/pdf',
+     *   size: 1024 * 1024,
+     * });
+     *
+     * // Upload file to the presigned URL
+     * await fetch(uploadUrl, {
+     *   method: 'PUT',
+     *   body: file,
+     *   headers: { 'Content-Type': 'application/pdf' },
+     * });
+     *
+     * // Confirm the upload
+     * const privateFile = await cdn.confirmPrivateUpload(fileId);
+     * ```
+     */
+    getPrivateUploadUrl(request: PrivateUploadUrlRequest): Promise<PrivateUploadUrlResponse>;
+    /**
+     * Confirm that a private file upload has completed
+     */
+    confirmPrivateUpload(fileId: string): Promise<PrivateFile>;
+    /**
+     * Upload a private file directly (handles presigned URL flow automatically)
+     *
+     * @example
+     * ```typescript
+     * const privateFile = await cdn.uploadPrivate({
+     *   projectSlug: 'my-project',
+     *   file: fileBuffer,
+     *   filename: 'confidential.pdf',
+     *   mimeType: 'application/pdf',
+     * });
+     * ```
+     */
+    uploadPrivate(options: {
+        projectSlug: string;
+        file: Blob | Buffer | ArrayBuffer;
+        filename: string;
+        mimeType: string;
+        folder?: string;
+        description?: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<PrivateFile>;
+    /**
+     * Generate a presigned download URL for a private file
+     *
+     * @example
+     * ```typescript
+     * const { downloadUrl, expiresAt } = await cdn.getPrivateDownloadUrl({
+     *   fileId: 'file-id',
+     *   expiresIn: 86400, // 24 hours
+     * });
+     * ```
+     */
+    getPrivateDownloadUrl(request: PrivateDownloadUrlRequest): Promise<PrivateDownloadUrlResponse>;
+    /**
+     * Get a private file by ID
+     */
+    getPrivateFile(fileId: string): Promise<PrivateFile>;
+    /**
+     * Update a private file's metadata
+     */
+    updatePrivateFile(request: UpdatePrivateFileRequest): Promise<PrivateFile>;
+    /**
+     * Delete a private file
+     */
+    deletePrivateFile(fileId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Delete multiple private files
+     */
+    deletePrivateFiles(fileIds: string[]): Promise<{
+        success: boolean;
+        deletedCount: number;
+    }>;
+    /**
+     * List private files with filters and pagination
+     *
+     * @example
+     * ```typescript
+     * const { files, total, hasMore } = await cdn.listPrivateFiles({
+     *   projectSlug: 'my-project',
+     *   limit: 20,
+     * });
+     * ```
+     */
+    listPrivateFiles(request: ListPrivateFilesRequest): Promise<ListPrivateFilesResponse>;
+    private convertPrivateFileDates;
+    /**
+     * Create a download bundle from assets and/or private files
+     *
+     * The bundle will be created asynchronously. Check the status using getBundle().
+     *
+     * @example
+     * ```typescript
+     * const { bundle } = await cdn.createBundle({
+     *   projectSlug: 'my-project',
+     *   name: 'Project Assets - Dec 2024',
+     *   assetIds: ['asset-1', 'asset-2'],
+     *   privateFileIds: ['file-1', 'file-2'],
+     *   expiresIn: 86400, // 24 hours
+     * });
+     * console.log(`Bundle ${bundle.id} status: ${bundle.status}`);
+     * ```
+     */
+    createBundle(request: CreateBundleRequest): Promise<CreateBundleResponse>;
+    /**
+     * Get a download bundle by ID
+     */
+    getBundle(bundleId: string): Promise<DownloadBundle>;
+    /**
+     * List download bundles with filters and pagination
+     *
+     * @example
+     * ```typescript
+     * const { bundles, total } = await cdn.listBundles({
+     *   projectSlug: 'my-project',
+     *   status: 'ready',
+     * });
+     * ```
+     */
+    listBundles(request: ListBundlesRequest): Promise<ListBundlesResponse>;
+    /**
+     * Generate a presigned download URL for a bundle
+     *
+     * @example
+     * ```typescript
+     * const { downloadUrl, expiresAt } = await cdn.getBundleDownloadUrl({
+     *   bundleId: 'bundle-id',
+     *   expiresIn: 3600, // 1 hour
+     * });
+     * ```
+     */
+    getBundleDownloadUrl(request: BundleDownloadUrlRequest): Promise<BundleDownloadUrlResponse>;
+    /**
+     * Delete a download bundle
+     */
+    deleteBundle(bundleId: string): Promise<{
+        success: boolean;
+    }>;
+    private convertBundleDates;
 }
 
-export { type Asset, type AssetStatus, type AssetType, CDN, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateFolderRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderTreeNode, type GetAssetRequest, type GetFolderTreeRequest, type ListAssetsRequest, type ListAssetsResponse, type ListJobsRequest, type ListJobsResponse, type MoveAssetsRequest, type MoveAssetsResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoOutputFormat, type VideoQuality, type VideoVariant, type WatermarkOptions };
+export { type Asset, type AssetStatus, type AssetType, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderTreeNode, type GetAssetRequest, type GetFolderTreeRequest, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListJobsRequest, type ListJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type MoveAssetsRequest, type MoveAssetsResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdatePrivateFileRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoOutputFormat, type VideoQuality, type VideoVariant, type WatermarkOptions };

package/dist/cdn/index.d.ts

@@ -260,6 +260,116 @@ interface ExtractAudioResponse {
     jobId: string;
     status: TranscodingStatus;
 }
+type PrivateFileStatus = "pending" | "ready" | "failed" | "deleted";
+interface PrivateFile {
+    id: string;
+    filename: string;
+    originalFilename: string;
+    mimeType: string;
+    size: number;
+    s3Key: string;
+    folder: string | null;
+    description: string | null;
+    tags: string[] | null;
+    metadata: Record<string, unknown> | null;
+    status: PrivateFileStatus;
+    createdAt: Date;
+    updatedAt: Date | null;
+}
+interface PrivateUploadUrlRequest {
+    projectSlug: string;
+    filename: string;
+    mimeType: string;
+    size: number;
+    folder?: string;
+    description?: string;
+    metadata?: Record<string, unknown>;
+}
+interface PrivateUploadUrlResponse {
+    uploadUrl: string;
+    fileId: string;
+    expiresAt: Date;
+}
+interface PrivateDownloadUrlRequest {
+    fileId: string;
+    /** Expiration time in seconds (default: 3600, min: 3600, max: 604800) */
+    expiresIn?: number;
+}
+interface PrivateDownloadUrlResponse {
+    downloadUrl: string;
+    expiresAt: Date;
+}
+interface ListPrivateFilesRequest {
+    projectSlug: string;
+    folder?: string | null;
+    status?: PrivateFileStatus;
+    search?: string;
+    sortBy?: "createdAt" | "filename" | "size";
+    sortOrder?: "asc" | "desc";
+    limit?: number;
+    offset?: number;
+}
+interface ListPrivateFilesResponse {
+    files: PrivateFile[];
+    total: number;
+    hasMore: boolean;
+}
+interface UpdatePrivateFileRequest {
+    fileId: string;
+    description?: string;
+    folder?: string | null;
+    tags?: string[];
+    metadata?: Record<string, unknown>;
+}
+type BundleStatus = "pending" | "processing" | "ready" | "failed" | "expired";
+interface DownloadBundle {
+    id: string;
+    name: string;
+    description: string | null;
+    assetIds: string[] | null;
+    privateFileIds: string[] | null;
+    s3Key: string | null;
+    size: number | null;
+    fileCount: number | null;
+    status: BundleStatus;
+    error: string | null;
+    expiresAt: Date | null;
+    createdAt: Date;
+    completedAt: Date | null;
+}
+interface CreateBundleRequest {
+    projectSlug: string;
+    name: string;
+    description?: string;
+    assetIds?: string[];
+    privateFileIds?: string[];
+    /** Expiration time in seconds (default: 86400, min: 3600, max: 604800) */
+    expiresIn?: number;
+}
+interface CreateBundleResponse {
+    bundle: DownloadBundle;
+}
+interface ListBundlesRequest {
+    projectSlug: string;
+    status?: BundleStatus;
+    search?: string;
+    limit?: number;
+    offset?: number;
+}
+interface ListBundlesResponse {
+    bundles: DownloadBundle[];
+    total: number;
+    hasMore: boolean;
+}
+interface BundleDownloadUrlRequest {
+    bundleId: string;
+    /** Expiration time in seconds (default: 3600, min: 3600, max: 604800) */
+    expiresIn?: number;
+}
+interface BundleDownloadUrlResponse {
+    downloadUrl: string;
+    expiresAt: Date;
+}
 
 /**
  * Stack0 CDN Client
@@ -563,6 +673,158 @@ declare class CDN {
      */
     extractAudio(request: ExtractAudioRequest): Promise<ExtractAudioResponse>;
     private convertJobDates;
+    /**
+     * Generate a presigned URL for uploading a private file
+     *
+     * Private files are stored securely and can only be accessed through
+     * authorized download links with configurable expiration.
+     *
+     * @example
+     * ```typescript
+     * const { uploadUrl, fileId } = await cdn.getPrivateUploadUrl({
+     *   projectSlug: 'my-project',
+     *   filename: 'confidential.pdf',
+     *   mimeType: 'application/pdf',
+     *   size: 1024 * 1024,
+     * });
+     *
+     * // Upload file to the presigned URL
+     * await fetch(uploadUrl, {
+     *   method: 'PUT',
+     *   body: file,
+     *   headers: { 'Content-Type': 'application/pdf' },
+     * });
+     *
+     * // Confirm the upload
+     * const privateFile = await cdn.confirmPrivateUpload(fileId);
+     * ```
+     */
+    getPrivateUploadUrl(request: PrivateUploadUrlRequest): Promise<PrivateUploadUrlResponse>;
+    /**
+     * Confirm that a private file upload has completed
+     */
+    confirmPrivateUpload(fileId: string): Promise<PrivateFile>;
+    /**
+     * Upload a private file directly (handles presigned URL flow automatically)
+     *
+     * @example
+     * ```typescript
+     * const privateFile = await cdn.uploadPrivate({
+     *   projectSlug: 'my-project',
+     *   file: fileBuffer,
+     *   filename: 'confidential.pdf',
+     *   mimeType: 'application/pdf',
+     * });
+     * ```
+     */
+    uploadPrivate(options: {
+        projectSlug: string;
+        file: Blob | Buffer | ArrayBuffer;
+        filename: string;
+        mimeType: string;
+        folder?: string;
+        description?: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<PrivateFile>;
+    /**
+     * Generate a presigned download URL for a private file
+     *
+     * @example
+     * ```typescript
+     * const { downloadUrl, expiresAt } = await cdn.getPrivateDownloadUrl({
+     *   fileId: 'file-id',
+     *   expiresIn: 86400, // 24 hours
+     * });
+     * ```
+     */
+    getPrivateDownloadUrl(request: PrivateDownloadUrlRequest): Promise<PrivateDownloadUrlResponse>;
+    /**
+     * Get a private file by ID
+     */
+    getPrivateFile(fileId: string): Promise<PrivateFile>;
+    /**
+     * Update a private file's metadata
+     */
+    updatePrivateFile(request: UpdatePrivateFileRequest): Promise<PrivateFile>;
+    /**
+     * Delete a private file
+     */
+    deletePrivateFile(fileId: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * Delete multiple private files
+     */
+    deletePrivateFiles(fileIds: string[]): Promise<{
+        success: boolean;
+        deletedCount: number;
+    }>;
+    /**
+     * List private files with filters and pagination
+     *
+     * @example
+     * ```typescript
+     * const { files, total, hasMore } = await cdn.listPrivateFiles({
+     *   projectSlug: 'my-project',
+     *   limit: 20,
+     * });
+     * ```
+     */
+    listPrivateFiles(request: ListPrivateFilesRequest): Promise<ListPrivateFilesResponse>;
+    private convertPrivateFileDates;
+    /**
+     * Create a download bundle from assets and/or private files
+     *
+     * The bundle will be created asynchronously. Check the status using getBundle().
+     *
+     * @example
+     * ```typescript
+     * const { bundle } = await cdn.createBundle({
+     *   projectSlug: 'my-project',
+     *   name: 'Project Assets - Dec 2024',
+     *   assetIds: ['asset-1', 'asset-2'],
+     *   privateFileIds: ['file-1', 'file-2'],
+     *   expiresIn: 86400, // 24 hours
+     * });
+     * console.log(`Bundle ${bundle.id} status: ${bundle.status}`);
+     * ```
+     */
+    createBundle(request: CreateBundleRequest): Promise<CreateBundleResponse>;
+    /**
+     * Get a download bundle by ID
+     */
+    getBundle(bundleId: string): Promise<DownloadBundle>;
+    /**
+     * List download bundles with filters and pagination
+     *
+     * @example
+     * ```typescript
+     * const { bundles, total } = await cdn.listBundles({
+     *   projectSlug: 'my-project',
+     *   status: 'ready',
+     * });
+     * ```
+     */
+    listBundles(request: ListBundlesRequest): Promise<ListBundlesResponse>;
+    /**
+     * Generate a presigned download URL for a bundle
+     *
+     * @example
+     * ```typescript
+     * const { downloadUrl, expiresAt } = await cdn.getBundleDownloadUrl({
+     *   bundleId: 'bundle-id',
+     *   expiresIn: 3600, // 1 hour
+     * });
+     * ```
+     */
+    getBundleDownloadUrl(request: BundleDownloadUrlRequest): Promise<BundleDownloadUrlResponse>;
+    /**
+     * Delete a download bundle
+     */
+    deleteBundle(bundleId: string): Promise<{
+        success: boolean;
+    }>;
+    private convertBundleDates;
 }
 
-export { type Asset, type AssetStatus, type AssetType, CDN, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateFolderRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderTreeNode, type GetAssetRequest, type GetFolderTreeRequest, type ListAssetsRequest, type ListAssetsResponse, type ListJobsRequest, type ListJobsResponse, type MoveAssetsRequest, type MoveAssetsResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoOutputFormat, type VideoQuality, type VideoVariant, type WatermarkOptions };
+export { type Asset, type AssetStatus, type AssetType, type BundleDownloadUrlRequest, type BundleDownloadUrlResponse, type BundleStatus, CDN, type ConfirmUploadRequest, type ConfirmUploadResponse, type CreateBundleRequest, type CreateBundleResponse, type CreateFolderRequest, type DeleteAssetRequest, type DeleteAssetsRequest, type DeleteAssetsResponse, type DownloadBundle, type ExtractAudioRequest, type ExtractAudioResponse, type Folder, type FolderTreeNode, type GetAssetRequest, type GetFolderTreeRequest, type ListAssetsRequest, type ListAssetsResponse, type ListBundlesRequest, type ListBundlesResponse, type ListJobsRequest, type ListJobsResponse, type ListPrivateFilesRequest, type ListPrivateFilesResponse, type MoveAssetsRequest, type MoveAssetsResponse, type PrivateDownloadUrlRequest, type PrivateDownloadUrlResponse, type PrivateFile, type PrivateFileStatus, type PrivateUploadUrlRequest, type PrivateUploadUrlResponse, type RegenerateThumbnailRequest, type RegenerateThumbnailResponse, type StreamingUrls, type ThumbnailRequest, type ThumbnailResponse, type TranscodeJob, type TranscodeVideoRequest, type TranscodingStatus, type TransformOptions, type TrimOptions, type UpdateAssetRequest, type UpdatePrivateFileRequest, type UploadUrlRequest, type UploadUrlResponse, type VideoCodec, type VideoOutputFormat, type VideoQuality, type VideoVariant, type WatermarkOptions };