@stack0/sdk 0.5.5 → 0.5.7

package/dist/cdn/index.d.mts

@@ -32,6 +32,11 @@ interface UploadUrlRequest {
     size: number;
     folder?: string;
     metadata?: Record<string, unknown>;
+    /**
+     * Watermark configuration for images.
+     * When provided, the watermark will be automatically applied during upload processing.
+     */
+    watermark?: ImageWatermarkConfig;
 }
 interface UploadUrlResponse {
     uploadUrl: string;
@@ -171,6 +176,47 @@ interface WatermarkOptions {
     position: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "center";
     opacity?: number;
 }
+/** Position options for image watermarks */
+type ImageWatermarkPosition = "top-left" | "top-center" | "top-right" | "center-left" | "center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+/** Sizing mode for image watermarks */
+type ImageWatermarkSizingMode = "absolute" | "relative";
+/**
+ * Configuration for applying a watermark to an uploaded image.
+ * Watermarks are applied automatically during the upload processing.
+ */
+interface ImageWatermarkConfig {
+    /**
+     * Source of the watermark image.
+     * Provide either assetId (another CDN asset) or url (direct URL).
+     */
+    assetId?: string;
+    /** Direct URL to watermark image (alternative to assetId) */
+    url?: string;
+    /** Position of the watermark on the image (default: "bottom-right") */
+    position?: ImageWatermarkPosition;
+    /** Horizontal offset from position in pixels (default: 0) */
+    offsetX?: number;
+    /** Vertical offset from position in pixels (default: 0) */
+    offsetY?: number;
+    /**
+     * Sizing mode for the watermark.
+     * - "absolute": Use exact width/height in pixels
+     * - "relative": Width/height as percentage of the main image (1-100)
+     */
+    sizingMode?: ImageWatermarkSizingMode;
+    /** Width of the watermark (pixels or percentage based on sizingMode) */
+    width?: number;
+    /** Height of the watermark (pixels or percentage based on sizingMode) */
+    height?: number;
+    /** Opacity of the watermark (0-100, default: 100) */
+    opacity?: number;
+    /** Rotation angle in degrees (-360 to 360, default: 0) */
+    rotation?: number;
+    /** Whether to tile/repeat the watermark across the image (default: false) */
+    tile?: boolean;
+    /** Spacing between tiles when tile is true (pixels, default: 100) */
+    tileSpacing?: number;
+}
 interface TrimOptions {
     start: number;
     end: number;
@@ -492,6 +538,54 @@ interface MovePrivateFilesResponse {
 type MergeStatus = TranscodingStatus;
 type MergeQuality = VideoQuality;
 type MergeOutputFormat = "mp4" | "webm";
+/**
+ * Text overlay shadow configuration
+ */
+interface TextOverlayShadow {
+    /** Shadow color in hex format (e.g., "#000000") */
+    color?: string;
+    /** Horizontal shadow offset in pixels (0-20) */
+    offsetX?: number;
+    /** Vertical shadow offset in pixels (0-20) */
+    offsetY?: number;
+}
+/**
+ * Text overlay stroke/outline configuration
+ */
+interface TextOverlayStroke {
+    /** Stroke color in hex format (e.g., "#000000") */
+    color?: string;
+    /** Stroke width in pixels (1-10) */
+    width?: number;
+}
+/**
+ * Text overlay configuration for adding captions to videos/images.
+ * Perfect for creating TikTok/Instagram style videos with text overlays.
+ */
+interface TextOverlay {
+    /** The text to display (1-500 characters) */
+    text: string;
+    /** Vertical position of the text (default: "bottom") */
+    position?: "top" | "center" | "bottom";
+    /** Font size in pixels (12-200, default: 48) */
+    fontSize?: number;
+    /** Font family (default: "Liberation Sans") */
+    fontFamily?: string;
+    /** Font weight (default: "bold") */
+    fontWeight?: "normal" | "bold";
+    /** Text color in hex format (default: "#FFFFFF") */
+    color?: string;
+    /** Background color (e.g., "rgba(0,0,0,0.5)") */
+    backgroundColor?: string;
+    /** Padding from edges in pixels (0-100, default: 20) */
+    padding?: number;
+    /** Maximum width as percentage of video width (10-100, default: 90) */
+    maxWidth?: number;
+    /** Shadow configuration for depth effect */
+    shadow?: TextOverlayShadow;
+    /** Stroke/outline configuration for better visibility */
+    stroke?: TextOverlayStroke;
+}
 /**
  * A single input item for the merge operation.
  * Can be a video, image, or audio file.
@@ -505,6 +599,8 @@ interface MergeInputItem {
     startTime?: number;
     /** End time in seconds for trimming (videos only) */
     endTime?: number;
+    /** Text overlay/caption configuration */
+    textOverlay?: TextOverlay;
 }
 /**
  * Audio track overlay configuration for merge jobs.
@@ -667,6 +763,21 @@ declare class CDN {
      *   filename: 'image.jpg',
      *   mimeType: 'image/jpeg',
      * });
+     *
+     * // With watermark
+     * const watermarkedAsset = await cdn.upload({
+     *   projectSlug: 'my-project',
+     *   file: fileBuffer,
+     *   filename: 'photo.jpg',
+     *   mimeType: 'image/jpeg',
+     *   watermark: {
+     *     assetId: 'logo-asset-id', // or url: 'https://example.com/logo.png'
+     *     position: 'bottom-right',
+     *     opacity: 50,
+     *     sizingMode: 'relative',
+     *     width: 15, // 15% of image width
+     *   },
+     * });
      * ```
      */
     upload(options: {
@@ -676,6 +787,8 @@ declare class CDN {
         mimeType: string;
         folder?: string;
         metadata?: Record<string, unknown>;
+        /** Watermark configuration for images (applied during upload processing) */
+        watermark?: ImageWatermarkConfig;
     }): Promise<Asset>;
     /**
      * Get an asset by ID
@@ -1270,4 +1383,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 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 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 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 };

package/dist/cdn/index.d.ts

@@ -32,6 +32,11 @@ interface UploadUrlRequest {
     size: number;
     folder?: string;
     metadata?: Record<string, unknown>;
+    /**
+     * Watermark configuration for images.
+     * When provided, the watermark will be automatically applied during upload processing.
+     */
+    watermark?: ImageWatermarkConfig;
 }
 interface UploadUrlResponse {
     uploadUrl: string;
@@ -171,6 +176,47 @@ interface WatermarkOptions {
     position: "top-left" | "top-right" | "bottom-left" | "bottom-right" | "center";
     opacity?: number;
 }
+/** Position options for image watermarks */
+type ImageWatermarkPosition = "top-left" | "top-center" | "top-right" | "center-left" | "center" | "center-right" | "bottom-left" | "bottom-center" | "bottom-right";
+/** Sizing mode for image watermarks */
+type ImageWatermarkSizingMode = "absolute" | "relative";
+/**
+ * Configuration for applying a watermark to an uploaded image.
+ * Watermarks are applied automatically during the upload processing.
+ */
+interface ImageWatermarkConfig {
+    /**
+     * Source of the watermark image.
+     * Provide either assetId (another CDN asset) or url (direct URL).
+     */
+    assetId?: string;
+    /** Direct URL to watermark image (alternative to assetId) */
+    url?: string;
+    /** Position of the watermark on the image (default: "bottom-right") */
+    position?: ImageWatermarkPosition;
+    /** Horizontal offset from position in pixels (default: 0) */
+    offsetX?: number;
+    /** Vertical offset from position in pixels (default: 0) */
+    offsetY?: number;
+    /**
+     * Sizing mode for the watermark.
+     * - "absolute": Use exact width/height in pixels
+     * - "relative": Width/height as percentage of the main image (1-100)
+     */
+    sizingMode?: ImageWatermarkSizingMode;
+    /** Width of the watermark (pixels or percentage based on sizingMode) */
+    width?: number;
+    /** Height of the watermark (pixels or percentage based on sizingMode) */
+    height?: number;
+    /** Opacity of the watermark (0-100, default: 100) */
+    opacity?: number;
+    /** Rotation angle in degrees (-360 to 360, default: 0) */
+    rotation?: number;
+    /** Whether to tile/repeat the watermark across the image (default: false) */
+    tile?: boolean;
+    /** Spacing between tiles when tile is true (pixels, default: 100) */
+    tileSpacing?: number;
+}
 interface TrimOptions {
     start: number;
     end: number;
@@ -492,6 +538,54 @@ interface MovePrivateFilesResponse {
 type MergeStatus = TranscodingStatus;
 type MergeQuality = VideoQuality;
 type MergeOutputFormat = "mp4" | "webm";
+/**
+ * Text overlay shadow configuration
+ */
+interface TextOverlayShadow {
+    /** Shadow color in hex format (e.g., "#000000") */
+    color?: string;
+    /** Horizontal shadow offset in pixels (0-20) */
+    offsetX?: number;
+    /** Vertical shadow offset in pixels (0-20) */
+    offsetY?: number;
+}
+/**
+ * Text overlay stroke/outline configuration
+ */
+interface TextOverlayStroke {
+    /** Stroke color in hex format (e.g., "#000000") */
+    color?: string;
+    /** Stroke width in pixels (1-10) */
+    width?: number;
+}
+/**
+ * Text overlay configuration for adding captions to videos/images.
+ * Perfect for creating TikTok/Instagram style videos with text overlays.
+ */
+interface TextOverlay {
+    /** The text to display (1-500 characters) */
+    text: string;
+    /** Vertical position of the text (default: "bottom") */
+    position?: "top" | "center" | "bottom";
+    /** Font size in pixels (12-200, default: 48) */
+    fontSize?: number;
+    /** Font family (default: "Liberation Sans") */
+    fontFamily?: string;
+    /** Font weight (default: "bold") */
+    fontWeight?: "normal" | "bold";
+    /** Text color in hex format (default: "#FFFFFF") */
+    color?: string;
+    /** Background color (e.g., "rgba(0,0,0,0.5)") */
+    backgroundColor?: string;
+    /** Padding from edges in pixels (0-100, default: 20) */
+    padding?: number;
+    /** Maximum width as percentage of video width (10-100, default: 90) */
+    maxWidth?: number;
+    /** Shadow configuration for depth effect */
+    shadow?: TextOverlayShadow;
+    /** Stroke/outline configuration for better visibility */
+    stroke?: TextOverlayStroke;
+}
 /**
  * A single input item for the merge operation.
  * Can be a video, image, or audio file.
@@ -505,6 +599,8 @@ interface MergeInputItem {
     startTime?: number;
     /** End time in seconds for trimming (videos only) */
     endTime?: number;
+    /** Text overlay/caption configuration */
+    textOverlay?: TextOverlay;
 }
 /**
  * Audio track overlay configuration for merge jobs.
@@ -667,6 +763,21 @@ declare class CDN {
      *   filename: 'image.jpg',
      *   mimeType: 'image/jpeg',
      * });
+     *
+     * // With watermark
+     * const watermarkedAsset = await cdn.upload({
+     *   projectSlug: 'my-project',
+     *   file: fileBuffer,
+     *   filename: 'photo.jpg',
+     *   mimeType: 'image/jpeg',
+     *   watermark: {
+     *     assetId: 'logo-asset-id', // or url: 'https://example.com/logo.png'
+     *     position: 'bottom-right',
+     *     opacity: 50,
+     *     sizingMode: 'relative',
+     *     width: 15, // 15% of image width
+     *   },
+     * });
      * ```
      */
     upload(options: {
@@ -676,6 +787,8 @@ declare class CDN {
         mimeType: string;
         folder?: string;
         metadata?: Record<string, unknown>;
+        /** Watermark configuration for images (applied during upload processing) */
+        watermark?: ImageWatermarkConfig;
     }): Promise<Asset>;
     /**
      * Get an asset by ID
@@ -1270,4 +1383,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 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 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 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 };

package/dist/cdn/index.js

@@ -134,10 +134,25 @@ var CDN = class {
    *   filename: 'image.jpg',
    *   mimeType: 'image/jpeg',
    * });
+   *
+   * // With watermark
+   * const watermarkedAsset = await cdn.upload({
+   *   projectSlug: 'my-project',
+   *   file: fileBuffer,
+   *   filename: 'photo.jpg',
+   *   mimeType: 'image/jpeg',
+   *   watermark: {
+   *     assetId: 'logo-asset-id', // or url: 'https://example.com/logo.png'
+   *     position: 'bottom-right',
+   *     opacity: 50,
+   *     sizingMode: 'relative',
+   *     width: 15, // 15% of image width
+   *   },
+   * });
    * ```
    */
   async upload(options) {
-    const { projectSlug, file, filename, mimeType, folder, metadata } = options;
+    const { projectSlug, file, filename, mimeType, folder, metadata, watermark } = options;
     let size;
     if (file instanceof Blob) {
       size = file.size;
@@ -152,7 +167,8 @@ var CDN = class {
       mimeType,
       size,
       folder,
-      metadata
+      metadata,
+      watermark
     });
     const uploadResponse = await fetch(uploadUrl, {
       method: "PUT",
@@ -653,10 +669,9 @@ var CDN = class {
    * ```
    */
   async getPrivateDownloadUrl(request) {
-    const response = await this.http.post(
-      `/cdn/private/${request.fileId}/download`,
-      { expiresIn: request.expiresIn }
-    );
+    const response = await this.http.post(`/cdn/private/${request.fileId}/download`, {
+      expiresIn: request.expiresIn
+    });
     if (typeof response.expiresAt === "string") {
       response.expiresAt = new Date(response.expiresAt);
     }
@@ -794,10 +809,9 @@ var CDN = class {
    * ```
    */
   async getBundleDownloadUrl(request) {
-    const response = await this.http.post(
-      `/cdn/bundles/${request.bundleId}/download`,
-      { expiresIn: request.expiresIn }
-    );
+    const response = await this.http.post(`/cdn/bundles/${request.bundleId}/download`, {
+      expiresIn: request.expiresIn
+    });
     if (typeof response.expiresAt === "string") {
       response.expiresAt = new Date(response.expiresAt);
     }