@blitzreels/sdk 0.1.3 → 0.1.5

package/dist/index.js

@@ -1,14 +1,21 @@
+import { createAiEditResource, } from "./resources/ai-edit.js";
+import { createCaptionsResource, } from "./resources/captions.js";
+import { createTimelineResource, } from "./resources/timeline.js";
 const DEFAULT_BASE_URL = "https://www.blitzreels.com/api/v1";
 export class BlitzReelsError extends Error {
     status;
     requestId;
     body;
+    code;
+    retryable;
     constructor(options) {
         super(options.message);
         this.name = "BlitzReelsError";
         this.status = options.status;
         this.requestId = options.requestId;
         this.body = options.body;
+        this.code = options.code ?? classifyBlitzReelsErrorCode(options);
+        this.retryable = options.retryable ?? isRetryableBlitzReelsStatus(options);
     }
 }
 function normalizeBaseUrl({ baseUrl, }) {
@@ -29,6 +36,37 @@ function appendQuery({ url, query, }) {
         }
     }
 }
+function classifyBlitzReelsErrorCode({ status, body, }) {
+    const bodyCode = extractErrorCode({ body });
+    if (bodyCode) {
+        return bodyCode;
+    }
+    if (status === 401 || status === 403) {
+        return "auth_error";
+    }
+    if (status === 404) {
+        return "not_found";
+    }
+    if (status === 409) {
+        return "conflict";
+    }
+    if (status === 408) {
+        return "timeout";
+    }
+    if (status === 400 || status === 422) {
+        return "validation_error";
+    }
+    if (status === 429) {
+        return "rate_limited";
+    }
+    if (status >= 500) {
+        return "server_error";
+    }
+    return "api_error";
+}
+function isRetryableBlitzReelsStatus({ status }) {
+    return status === 408 || status === 429 || status >= 500;
+}
 function extractErrorMessage({ body }) {
     if (body === null || typeof body !== "object") {
         return null;
@@ -37,6 +75,44 @@ function extractErrorMessage({ body }) {
     const message = record.message ?? record.error;
     return typeof message === "string" ? message : null;
 }
+function extractErrorCode({ body, }) {
+    if (body === null || typeof body !== "object") {
+        return null;
+    }
+    const value = body.code;
+    if (value === "api_error" ||
+        value === "auth_error" ||
+        value === "not_found" ||
+        value === "conflict" ||
+        value === "validation_error" ||
+        value === "rate_limited" ||
+        value === "timeout" ||
+        value === "server_error") {
+        return value;
+    }
+    return null;
+}
+function normalizeMediaPositionPreset({ value, }) {
+    if (value === "full-screen") {
+        return "fullscreen";
+    }
+    if (value === "top-left") {
+        return "pip-top-left";
+    }
+    if (value === "top-right") {
+        return "pip-top-right";
+    }
+    if (value === "bottom-left") {
+        return "pip-bottom-left";
+    }
+    if (value === "bottom-right") {
+        return "pip-bottom-right";
+    }
+    return value;
+}
+function normalizeMediaAnimationPreset({ value, }) {
+    return value === "slideIn" ? "slideUp" : value;
+}
 function sleep({ ms }) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
@@ -87,12 +163,18 @@ export class BlitzReelsClient {
     auth;
     projects;
     timeline;
+    effects;
     workspace;
     media;
+    clips;
     text;
     audio;
+    audioLibrary;
+    stockMedia;
+    library;
     silence;
     mistakes;
+    aiEdit;
     captions;
     exports;
     jobs;
@@ -158,13 +240,27 @@ export class BlitzReelsClient {
             inspect: (options) => this.request({
                 method: "GET",
                 path: `/projects/${encodeURIComponent(options.projectId)}/context`,
-                query: { mode: options.mode },
+                query: {
+                    mode: options.mode,
+                    asset_limit: options.assetLimit,
+                    asset_offset: options.assetOffset,
+                    timeline_limit: options.timelineLimit,
+                    timeline_offset: options.timelineOffset,
+                    transcript_limit: options.transcriptLimit,
+                    transcript_offset: options.transcriptOffset,
+                    caption_word_limit: options.captionWordLimit,
+                    caption_word_offset: options.captionWordOffset,
+                },
                 body: undefined,
             }),
             timeline: (options) => this.request({
                 method: "GET",
                 path: `/projects/${encodeURIComponent(options.projectId)}/context`,
-                query: { mode: "timeline" },
+                query: {
+                    mode: "timeline",
+                    timeline_limit: options.limit,
+                    timeline_offset: options.offset,
+                },
                 body: undefined,
             }),
             renderSnapshot: (options) => this.request({
@@ -188,48 +284,100 @@ export class BlitzReelsClient {
                 },
             }),
         };
-        this.timeline = {
-            transform: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/timeline/edits`,
-                query: undefined,
-                body: {
-                    action: "transform",
-                    timeline_item_id: options.timelineItemId,
-                    position_x: options.positionX,
-                    position_y: options.positionY,
-                    width_px: options.widthPx,
-                    height_px: options.heightPx,
-                    keep_aspect_ratio: options.keepAspectRatio,
-                },
-            }),
-            move: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/timeline/edits`,
-                query: undefined,
-                body: {
-                    action: "move",
-                    timeline_item_id: options.timelineItemId,
-                    new_start_seconds: options.newStartSeconds,
-                    new_layer_index: options.newLayerIndex,
-                },
-            }),
-            delete: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/timeline/edits`,
-                query: undefined,
-                body: {
-                    action: "delete",
-                    timeline_item_ids: options.timelineItemIds,
-                    auto_pack: options.autoPack,
-                },
-            }),
-            deleteItem: (options) => this.request({
-                method: "DELETE",
-                path: `/projects/${encodeURIComponent(options.projectId)}/timeline/items/${encodeURIComponent(options.timelineItemId)}`,
-                query: undefined,
-                body: undefined,
-            }),
+        this.timeline = createTimelineResource({
+            request: (options) => this.request(options),
+        });
+        this.aiEdit = createAiEditResource({
+            request: (options) => this.request(options),
+        });
+        this.effects = {
+            zoom: {
+                add: (options) => this.request({
+                    method: "POST",
+                    path: `/projects/${encodeURIComponent(options.projectId)}/effects/zoom`,
+                    query: undefined,
+                    body: {
+                        timeline_item_id: options.timelineItemId,
+                        content_item_id: options.contentItemId,
+                        effect_id: options.effectId,
+                        name: options.name,
+                        start_time_seconds: options.startTimeSeconds,
+                        duration_seconds: options.durationSeconds,
+                        easing: options.easing,
+                        layer_index: options.layerIndex,
+                        order_index: options.orderIndex,
+                        settings: options.settings,
+                    },
+                }),
+                update: (options) => this.request({
+                    method: "PATCH",
+                    path: `/projects/${encodeURIComponent(options.projectId)}/effects/zoom/${encodeURIComponent(options.timelineItemId)}`,
+                    query: undefined,
+                    body: {
+                        duration_seconds: options.durationSeconds,
+                        easing: options.easing,
+                        settings: options.settings,
+                    },
+                }),
+            },
+            mask: {
+                add: (options) => this.request({
+                    method: "POST",
+                    path: `/projects/${encodeURIComponent(options.projectId)}/effects/mask`,
+                    query: undefined,
+                    body: {
+                        timeline_item_id: options.timelineItemId,
+                        content_item_id: options.contentItemId,
+                        effect_id: options.effectId,
+                        name: options.name,
+                        start_time_seconds: options.startTimeSeconds,
+                        duration_seconds: options.durationSeconds,
+                        easing: options.easing,
+                        layer_index: options.layerIndex,
+                        order_index: options.orderIndex,
+                        settings: options.settings,
+                    },
+                }),
+                update: (options) => this.request({
+                    method: "PATCH",
+                    path: `/projects/${encodeURIComponent(options.projectId)}/effects/mask/${encodeURIComponent(options.timelineItemId)}`,
+                    query: undefined,
+                    body: {
+                        duration_seconds: options.durationSeconds,
+                        easing: options.easing,
+                        settings: options.settings,
+                    },
+                }),
+            },
+            colorgrade: {
+                add: (options) => this.request({
+                    method: "POST",
+                    path: `/projects/${encodeURIComponent(options.projectId)}/effects/colorgrade`,
+                    query: undefined,
+                    body: {
+                        timeline_item_id: options.timelineItemId,
+                        content_item_id: options.contentItemId,
+                        effect_id: options.effectId,
+                        name: options.name,
+                        start_time_seconds: options.startTimeSeconds,
+                        duration_seconds: options.durationSeconds,
+                        easing: options.easing,
+                        layer_index: options.layerIndex,
+                        order_index: options.orderIndex,
+                        settings: options.settings,
+                    },
+                }),
+                update: (options) => this.request({
+                    method: "PATCH",
+                    path: `/projects/${encodeURIComponent(options.projectId)}/effects/colorgrade/${encodeURIComponent(options.timelineItemId)}`,
+                    query: undefined,
+                    body: {
+                        duration_seconds: options.durationSeconds,
+                        easing: options.easing,
+                        settings: options.settings,
+                    },
+                }),
+            },
         };
         this.workspace = {
             getSettings: () => this.request({
@@ -279,6 +427,12 @@ export class BlitzReelsClient {
                 query: undefined,
                 body: undefined,
             }),
+            clippingStatus: (options) => this.request({
+                method: "GET",
+                path: `/workspace/media/assets/${encodeURIComponent(options.assetId)}/clipping-status`,
+                query: { project_id: options.projectId },
+                body: undefined,
+            }),
             delete: (options) => this.request({
                 method: "POST",
                 path: `/workspace/media/assets/${encodeURIComponent(options.assetId)}/delete`,
@@ -351,20 +505,76 @@ export class BlitzReelsClient {
                             asset_id: options.assetId,
                             start_seconds: options.startSeconds ?? 0,
                             duration_seconds: options.durationSeconds,
-                            position_preset: options.positionPreset,
+                            position_preset: normalizeMediaPositionPreset({
+                                value: options.positionPreset,
+                            }),
                             position_x: options.positionX,
                             position_y: options.positionY,
                             width_px: options.widthPx,
                             height_px: options.heightPx,
+                            keep_aspect_ratio: options.keepAspectRatio,
                             scale: options.scale,
                             opacity: options.opacity,
-                            animation_preset: options.animationPreset,
+                            animation_preset: normalizeMediaAnimationPreset({
+                                value: options.animationPreset,
+                            }),
                             layer_index: options.layerIndex,
                         },
                     ],
                     allow_duplicate: options.allowDuplicate,
                 },
             }),
+            updateOverlay: (options) => this.request({
+                method: "PATCH",
+                path: `/projects/${encodeURIComponent(options.projectId)}/timeline/media/${encodeURIComponent(options.timelineItemId)}`,
+                query: undefined,
+                body: {
+                    position_preset: normalizeMediaPositionPreset({
+                        value: options.positionPreset,
+                    }),
+                    position_x: options.positionX,
+                    position_y: options.positionY,
+                    width_px: options.widthPx,
+                    height_px: options.heightPx,
+                    keep_aspect_ratio: options.keepAspectRatio,
+                    scale: options.scale,
+                    opacity: options.opacity,
+                    animation_preset: normalizeMediaAnimationPreset({
+                        value: options.animationPreset,
+                    }),
+                    remove_animations: options.removeAnimations,
+                    blurred_background: options.blurredBackground,
+                },
+            }),
+            shorts: {
+                list: (options) => this.request({
+                    method: "GET",
+                    path: `/workspace/media/assets/${encodeURIComponent(options.assetId)}/short-suggestions`,
+                    query: undefined,
+                    body: undefined,
+                }),
+                generate: (options) => this.request({
+                    method: "POST",
+                    path: `/workspace/media/assets/${encodeURIComponent(options.assetId)}/short-suggestions`,
+                    query: undefined,
+                    body: {
+                        content_profile: options.contentProfile,
+                        auto_trim_silence: options.autoTrimSilence,
+                    },
+                }),
+                apply: (options) => this.request({
+                    method: "POST",
+                    path: `/workspace/media/assets/${encodeURIComponent(options.assetId)}/short-suggestions/${encodeURIComponent(options.suggestionId)}/apply`,
+                    query: undefined,
+                    body: {
+                        project_id: options.projectId,
+                        caption_style_id: options.captionStyleId,
+                        mark_saved: options.markSaved,
+                        allow_unverified_export: options.allowUnverifiedExport,
+                        automatic_layout: options.automaticLayout,
+                    },
+                }),
+            },
             folders: {
                 list: (options) => this.request({
                     method: "GET",
@@ -402,6 +612,89 @@ export class BlitzReelsClient {
                 }),
             },
         };
+        this.clips = {
+            create: (options) => this.request({
+                method: "POST",
+                path: "/clips",
+                query: undefined,
+                body: {
+                    project_name: options.projectName,
+                    source: {
+                        source_type: options.source.sourceType,
+                        asset_id: options.source.assetId,
+                        youtube_url: options.source.youtubeUrl,
+                    },
+                    selection: {
+                        selection_mode: options.selection.mode,
+                        suggestion_id: options.selection.suggestionId,
+                        start_seconds: options.selection.startSeconds,
+                        end_seconds: options.selection.endSeconds,
+                    },
+                    target: {
+                        aspect_ratio: options.target.aspectRatio,
+                        min_duration_seconds: options.target.minDurationSeconds,
+                        max_duration_seconds: options.target.maxDurationSeconds,
+                    },
+                    layout: {
+                        layout_mode: options.layout.mode,
+                        content_type_hint: options.layout.contentTypeHint,
+                    },
+                    captions: {
+                        enabled: options.captions.enabled,
+                        style_id: options.captions.styleId,
+                    },
+                    qa: {
+                        qa_mode: options.qa.mode,
+                    },
+                    export: {
+                        auto_export: options.export.autoExport,
+                    },
+                },
+            }),
+            get: (options) => this.request({
+                method: "GET",
+                path: `/clips/${encodeURIComponent(options.clipId)}`,
+                query: undefined,
+                body: undefined,
+            }),
+            reselect: (options) => this.request({
+                method: "POST",
+                path: `/clips/${encodeURIComponent(options.clipId)}/reselect`,
+                query: undefined,
+                body: {
+                    selection: {
+                        selection_mode: options.selection.mode,
+                        suggestion_id: options.selection.suggestionId,
+                        start_seconds: options.selection.startSeconds,
+                        end_seconds: options.selection.endSeconds,
+                    },
+                    target: options.target === null || options.target === undefined
+                        ? null
+                        : {
+                            min_duration_seconds: options.target.minDurationSeconds,
+                            max_duration_seconds: options.target.maxDurationSeconds,
+                        },
+                },
+            }),
+            repair: (options) => this.request({
+                method: "POST",
+                path: `/clips/${encodeURIComponent(options.clipId)}/repair`,
+                query: undefined,
+                body: {
+                    repair_mode: options.repairMode,
+                },
+            }),
+            export: (options) => this.request({
+                method: "POST",
+                path: `/clips/${encodeURIComponent(options.clipId)}/export`,
+                query: undefined,
+                body: {
+                    resolution: options.resolution,
+                    format: options.format,
+                    allow_blocking_qa_bypass: options.allowBlockingQaBypass,
+                },
+            }),
+        };
         this.text = {
             add: (options) => this.request({
                 method: "POST",
@@ -429,6 +722,7 @@ export class BlitzReelsClient {
                 text: options.text,
                 name: options.name,
                 spec: options.spec,
+                durationSeconds: options.durationSeconds,
             }),
             remove: (options) => this.request({
                 method: "DELETE",
@@ -456,6 +750,102 @@ export class BlitzReelsClient {
                     ],
                 },
             }),
+            update: (options) => this.request({
+                method: "PATCH",
+                path: `/projects/${encodeURIComponent(options.projectId)}/timeline/audio/${encodeURIComponent(options.timelineItemId)}`,
+                query: undefined,
+                body: {
+                    duration_seconds: options.durationSeconds,
+                    volume: options.volume,
+                    fade_in_seconds: options.fadeInSeconds,
+                    fade_out_seconds: options.fadeOutSeconds,
+                },
+            }),
+        };
+        this.audioLibrary = {
+            search: (options) => this.request({
+                method: "GET",
+                path: "/audio-library/search",
+                query: {
+                    query: options.query,
+                    provider: options.provider,
+                    license: options.license,
+                    audio_type: options.audioType,
+                    min_duration_seconds: options.minDurationSeconds,
+                    max_duration_seconds: options.maxDurationSeconds,
+                    limit: options.limit,
+                    page: options.page,
+                },
+                body: undefined,
+            }),
+            importAsset: (options) => this.request({
+                method: "POST",
+                path: "/audio-library/import",
+                query: undefined,
+                body: {
+                    provider: options.provider,
+                    external_id: options.externalId,
+                    folder_id: options.folderId,
+                    project_id: options.projectId,
+                    start_seconds: options.startSeconds,
+                    duration_seconds: options.durationSeconds,
+                    volume: options.volume,
+                    fade_in_seconds: options.fadeInSeconds,
+                    fade_out_seconds: options.fadeOutSeconds,
+                    loop: options.loop,
+                    audio_type: options.audioType,
+                },
+            }),
+        };
+        this.stockMedia = {
+            search: (options) => this.request({
+                method: "GET",
+                path: "/workspace/stock-media/search",
+                query: {
+                    query: options.query,
+                    asset_type: options.assetType,
+                    provider: options.provider,
+                    orientation: options.orientation,
+                    page: options.page,
+                    limit: options.limit,
+                },
+                body: undefined,
+            }),
+            importAsset: (options) => this.request({
+                method: "POST",
+                path: "/workspace/stock-media/import",
+                query: undefined,
+                body: {
+                    provider: options.provider,
+                    provider_asset_id: options.providerAssetId,
+                    asset_type: options.assetType,
+                    variant_id: options.variantId,
+                    folder_id: options.folderId,
+                    audio_type: options.audioType,
+                },
+            }),
+        };
+        this.library = {
+            search: (options) => this.request({
+                method: "GET",
+                path: "/library/broll/search",
+                query: {
+                    query: options.query,
+                    asset_type: options.assetType,
+                    audio_type: options.audioType,
+                    limit: options.limit,
+                    offset: options.offset,
+                },
+                body: undefined,
+            }),
+            importAsset: (options) => this.request({
+                method: "POST",
+                path: `/library/broll/${encodeURIComponent(options.libraryAssetId)}/import`,
+                query: undefined,
+                body: {
+                    folder_id: options.folderId,
+                },
+            }),
         };
         this.silence = {
             plan: (options) => this.request({
@@ -464,6 +854,8 @@ export class BlitzReelsClient {
                 query: undefined,
                 body: {
                     timeline_item_id: options.timelineItemId,
+                    all_media_items: options.allMediaItems,
+                    strategy: options.strategy,
                     padding_ms: options.paddingMs,
                     silence_threshold_db: options.silenceThresholdDb,
                     min_silence_duration_seconds: options.minSilenceDurationSeconds,
@@ -477,6 +869,7 @@ export class BlitzReelsClient {
                 query: undefined,
                 body: {
                     timeline_item_id: options.timelineItemId,
+                    all_media_items: options.allMediaItems,
                     padding_ms: options.paddingMs,
                     silence_threshold_db: options.silenceThresholdDb,
                     min_silence_duration_seconds: options.minSilenceDurationSeconds,
@@ -484,6 +877,11 @@ export class BlitzReelsClient {
                     use_caption_validation: options.useCaptionValidation,
                     delete_silent_clips: options.deleteSilentClips,
                     manual_segment_overrides: options.manualSegmentOverrides,
+                    segments: options.segments?.map((segment) => ({
+                        timeline_item_id: segment.timelineItemId,
+                        start_seconds: segment.startSeconds,
+                        end_seconds: segment.endSeconds,
+                    })),
                     preview_confirmed: options.previewConfirmed,
                 },
             }),
@@ -510,111 +908,9 @@ export class BlitzReelsClient {
                 },
             }),
         };
-        this.captions = {
-            listWords: (options) => this.request({
-                method: "GET",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words`,
-                query: {
-                    timeline_item_id: options.timelineItemId,
-                    match_text: options.matchText,
-                    limit: options.limit,
-                    offset: options.offset,
-                },
-                body: undefined,
-            }),
-            updateWordText: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/text`,
-                query: undefined,
-                body: {
-                    word_id: options.wordId,
-                    new_text: options.newText,
-                },
-            }),
-            batchUpdateWordText: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/batch-text`,
-                query: undefined,
-                body: {
-                    updates: options.updates,
-                },
-            }),
-            setWordStyle: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/style`,
-                query: undefined,
-                body: {
-                    style: options.style,
-                    clear_existing: options.clearExisting,
-                    word_ids: options.wordIds,
-                    match_text: options.matchText,
-                    match_pattern: options.matchPattern,
-                    timeline_item_id: options.timelineItemId,
-                },
-            }),
-            setWordEmphasis: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/emphasis`,
-                query: undefined,
-                body: {
-                    emphasis: options.emphasis,
-                    word_ids: options.wordIds,
-                    match_text: options.matchText,
-                    match_pattern: options.matchPattern,
-                    timeline_item_id: options.timelineItemId,
-                },
-            }),
-            deleteWords: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/delete`,
-                query: undefined,
-                body: { word_ids: options.wordIds },
-            }),
-            mergeWords: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/merge`,
-                query: undefined,
-                body: { word_ids: options.wordIds, text: options.text },
-            }),
-            splitWord: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/captions/words/split`,
-                query: undefined,
-                body: { word_id: options.wordId, words: options.words },
-            }),
-            listThemes: () => this.request({
-                method: "GET",
-                path: "/caption-themes",
-                query: undefined,
-                body: undefined,
-            }),
-            setDefaultTheme: (options) => this.request({
-                method: "POST",
-                path: `/caption-themes/${encodeURIComponent(options.themeId)}/set-default`,
-                query: undefined,
-                body: {},
-            }),
-            setProjectTheme: (options) => this.request({
-                method: "POST",
-                path: `/projects/${encodeURIComponent(options.projectId)}/caption-theme`,
-                query: undefined,
-                body: {
-                    theme_id: options.themeId,
-                },
-            }),
-            previewTheme: (options) => this.request({
-                method: "POST",
-                path: "/caption-themes/preview",
-                query: undefined,
-                body: {
-                    settings: options.settings,
-                    sample_text: options.sampleText,
-                    aspect_ratio: options.aspectRatio,
-                    target_width: options.targetWidth,
-                    image_format: options.imageFormat,
-                },
-            }),
-        };
+        this.captions = createCaptionsResource({
+            request: (options) => this.request(options),
+        });
         this.exports = {
             start: (options) => this.request({
                 method: "POST",
@@ -623,7 +919,7 @@ export class BlitzReelsClient {
                 body: {
                     resolution: options.resolution,
                     format: options.format,
-                    include_captions: options.includeCaptions,
+                    cover_frame_seconds: options.coverFrameSeconds,
                 },
             }),
             get: (options) => this.request({
@@ -727,6 +1023,7 @@ export class BlitzReelsClient {
             body: {
                 name: options.name,
                 spec,
+                duration_seconds: options.durationSeconds,
             },
         });
     }