sonilo 0.14.0 → 0.15.0

package/dist/index.d.cts

@@ -511,6 +511,50 @@ interface DubbingResult extends BaseTaskResult {
      */
     outputs?: Record<string, string>;
 }
+interface VideoAnalysisParams {
+    /** Exactly one of `video` / `videoUrl`. */
+    video?: VideoInput;
+    /** Exactly one of `video` / `videoUrl`. */
+    videoUrl?: string;
+    /** Optional guidance for the analysis, at most 2000 characters. */
+    prompt?: string;
+    /**
+     * How many independent creative briefs to author for the same video
+     * (1-5, default 1). Billed per brief.
+     */
+    variantsNum?: number;
+}
+/** One time-aligned section of the analyzed video, with the scoring
+ * direction for that stretch. Bounds are whole seconds — the backend
+ * truncates any fractional upstream bound before it reaches the envelope. */
+interface AnalysisSegment {
+    start: number;
+    end: number;
+    /** The backend always emits one, defaulting to the string `"none"`. */
+    label: string;
+    prompt: string;
+}
+/** One independent creative brief for the whole video. Only the generation
+ * prompt is public — the upstream's title/summary/tags are internal display
+ * copy the API deliberately does not resell. */
+interface AnalysisVariation {
+    prompt: string;
+}
+/**
+ * The only Sonilo result with no media artifact at all: video-analysis
+ * generates nothing and there is nothing to download. The payload is the
+ * work order — `segments` for a time-aligned plan, and one `prompt` per
+ * requested variation, each ready to pass to videoToMusic, videoToSfx,
+ * videoToSound or their video-to-video counterparts.
+ *
+ * Both lists are optional because a `processing` or `failed` poll carries
+ * neither.
+ */
+interface VideoAnalysisResult extends BaseTaskResult {
+    segments?: AnalysisSegment[];
+    variations?: AnalysisVariation[];
+    duration_seconds?: number;
+}
 
 declare class Account {
     private readonly client;
@@ -648,6 +692,28 @@ declare class Dubbing {
     generate(params: DubbingParams, opts?: WaitOptions): Promise<DubbingResult>;
 }
 
+/** Analyze a video and get back a creative brief for scoring it. Async only.
+ *
+ * This endpoint generates nothing — no audio, no video, no artifact to
+ * download. The result is the work order: `segments` (a time-aligned section
+ * plan) plus one `prompt` per requested variation, each ready to hand
+ * straight to videoToMusic, videoToSfx, videoToSound or their
+ * video-to-video counterparts.
+ *
+ * The method is `analyze`, not `generate`, for that reason: every other
+ * resource's `generate` returns something you download, and this one never
+ * does.
+ *
+ * The 1-5 bound on `variantsNum` and the 2000-character bound on `prompt`
+ * are deliberately not checked here — the backend owns them, and a hardcoded
+ * copy would make this SDK reject values a later API widens. */
+declare class VideoAnalysis {
+    private readonly client;
+    constructor(client: SoniloClient);
+    submit(params: VideoAnalysisParams): Promise<SfxTask>;
+    analyze(params: VideoAnalysisParams, opts?: WaitOptions): Promise<VideoAnalysisResult>;
+}
+
 interface SoniloClientOptions {
     /** Defaults to the SONILO_API_KEY environment variable (Node.js only). */
     apiKey?: string;
@@ -687,6 +753,7 @@ declare class SoniloClient {
     readonly videoToVideoSound: VideoToVideoSound;
     readonly audioDucking: AudioDucking;
     readonly dubbing: Dubbing;
+    readonly videoAnalysis: VideoAnalysis;
     constructor(options?: SoniloClientOptions);
     /**
      * Perform an authenticated request; throws a typed error on non-2xx.
@@ -768,6 +835,6 @@ declare class RequestTimeoutError extends SoniloError {
 declare function download(media: SfxMedia | string | undefined, fetchFn?: typeof globalThis.fetch, timeout?: number): Promise<Uint8Array>;
 
 /** The SDK's own version. Generated by scripts/sync-versions.mjs — do not edit. */
-declare const VERSION = "0.14.0";
+declare const VERSION = "0.15.0";
 
-export { APIError, type AccountServices, type AudioChunkEvent, type AudioDuckingParams, AuthenticationError, BadRequestError, type BaseTaskResult, type CompleteEvent, type CostEvent, type CostInfo, DEFAULT_TIMEOUT_MS, type DailyUsage, type DubbingLanguage, type DubbingParams, type DubbingResult, type DuckingResult, type ErrorEvent, GenerationError, type MusicMediaEntry, type MusicMuxEntry, type MusicTaskResult, type MusicTitle, PaymentRequiredError, RateLimitError, RequestTimeoutError, type Segment, type SegmentLabel, type SfxAudioFormat, type SfxError, type SfxMedia, type SfxResult, type SfxSegment, type SfxTask, SoniloClient, type SoniloClientOptions, SoniloError, type SoundOutputEntry, type SoundResult, type StreamEvent, TaskFailedError, TaskTimeoutError, type TextToMusicParams, type TextToSfxParams, type TitleEvent, type Track, TrialExhaustedError, type TrialQuota, type UnknownEvent, type UsageResponse, type UsageSummary, VERSION, type VideoInput, type VideoResult, type VideoToMusicParams, type VideoToSfxParams, type VideoToSoundParams, type VideoToVideoMusicParams, type VideoToVideoSfxParams, type VideoToVideoSoundParams, type WaitOptions, download, isAudioChunkEvent, isErrorEvent };
+export { APIError, type AccountServices, type AnalysisSegment, type AnalysisVariation, type AudioChunkEvent, type AudioDuckingParams, AuthenticationError, BadRequestError, type BaseTaskResult, type CompleteEvent, type CostEvent, type CostInfo, DEFAULT_TIMEOUT_MS, type DailyUsage, type DubbingLanguage, type DubbingParams, type DubbingResult, type DuckingResult, type ErrorEvent, GenerationError, type MusicMediaEntry, type MusicMuxEntry, type MusicTaskResult, type MusicTitle, PaymentRequiredError, RateLimitError, RequestTimeoutError, type Segment, type SegmentLabel, type SfxAudioFormat, type SfxError, type SfxMedia, type SfxResult, type SfxSegment, type SfxTask, SoniloClient, type SoniloClientOptions, SoniloError, type SoundOutputEntry, type SoundResult, type StreamEvent, TaskFailedError, TaskTimeoutError, type TextToMusicParams, type TextToSfxParams, type TitleEvent, type Track, TrialExhaustedError, type TrialQuota, type UnknownEvent, type UsageResponse, type UsageSummary, VERSION, type VideoAnalysisParams, type VideoAnalysisResult, type VideoInput, type VideoResult, type VideoToMusicParams, type VideoToSfxParams, type VideoToSoundParams, type VideoToVideoMusicParams, type VideoToVideoSfxParams, type VideoToVideoSoundParams, type WaitOptions, download, isAudioChunkEvent, isErrorEvent };

package/dist/index.d.ts

@@ -511,6 +511,50 @@ interface DubbingResult extends BaseTaskResult {
      */
     outputs?: Record<string, string>;
 }
+interface VideoAnalysisParams {
+    /** Exactly one of `video` / `videoUrl`. */
+    video?: VideoInput;
+    /** Exactly one of `video` / `videoUrl`. */
+    videoUrl?: string;
+    /** Optional guidance for the analysis, at most 2000 characters. */
+    prompt?: string;
+    /**
+     * How many independent creative briefs to author for the same video
+     * (1-5, default 1). Billed per brief.
+     */
+    variantsNum?: number;
+}
+/** One time-aligned section of the analyzed video, with the scoring
+ * direction for that stretch. Bounds are whole seconds — the backend
+ * truncates any fractional upstream bound before it reaches the envelope. */
+interface AnalysisSegment {
+    start: number;
+    end: number;
+    /** The backend always emits one, defaulting to the string `"none"`. */
+    label: string;
+    prompt: string;
+}
+/** One independent creative brief for the whole video. Only the generation
+ * prompt is public — the upstream's title/summary/tags are internal display
+ * copy the API deliberately does not resell. */
+interface AnalysisVariation {
+    prompt: string;
+}
+/**
+ * The only Sonilo result with no media artifact at all: video-analysis
+ * generates nothing and there is nothing to download. The payload is the
+ * work order — `segments` for a time-aligned plan, and one `prompt` per
+ * requested variation, each ready to pass to videoToMusic, videoToSfx,
+ * videoToSound or their video-to-video counterparts.
+ *
+ * Both lists are optional because a `processing` or `failed` poll carries
+ * neither.
+ */
+interface VideoAnalysisResult extends BaseTaskResult {
+    segments?: AnalysisSegment[];
+    variations?: AnalysisVariation[];
+    duration_seconds?: number;
+}
 
 declare class Account {
     private readonly client;
@@ -648,6 +692,28 @@ declare class Dubbing {
     generate(params: DubbingParams, opts?: WaitOptions): Promise<DubbingResult>;
 }
 
+/** Analyze a video and get back a creative brief for scoring it. Async only.
+ *
+ * This endpoint generates nothing — no audio, no video, no artifact to
+ * download. The result is the work order: `segments` (a time-aligned section
+ * plan) plus one `prompt` per requested variation, each ready to hand
+ * straight to videoToMusic, videoToSfx, videoToSound or their
+ * video-to-video counterparts.
+ *
+ * The method is `analyze`, not `generate`, for that reason: every other
+ * resource's `generate` returns something you download, and this one never
+ * does.
+ *
+ * The 1-5 bound on `variantsNum` and the 2000-character bound on `prompt`
+ * are deliberately not checked here — the backend owns them, and a hardcoded
+ * copy would make this SDK reject values a later API widens. */
+declare class VideoAnalysis {
+    private readonly client;
+    constructor(client: SoniloClient);
+    submit(params: VideoAnalysisParams): Promise<SfxTask>;
+    analyze(params: VideoAnalysisParams, opts?: WaitOptions): Promise<VideoAnalysisResult>;
+}
+
 interface SoniloClientOptions {
     /** Defaults to the SONILO_API_KEY environment variable (Node.js only). */
     apiKey?: string;
@@ -687,6 +753,7 @@ declare class SoniloClient {
     readonly videoToVideoSound: VideoToVideoSound;
     readonly audioDucking: AudioDucking;
     readonly dubbing: Dubbing;
+    readonly videoAnalysis: VideoAnalysis;
     constructor(options?: SoniloClientOptions);
     /**
      * Perform an authenticated request; throws a typed error on non-2xx.
@@ -768,6 +835,6 @@ declare class RequestTimeoutError extends SoniloError {
 declare function download(media: SfxMedia | string | undefined, fetchFn?: typeof globalThis.fetch, timeout?: number): Promise<Uint8Array>;
 
 /** The SDK's own version. Generated by scripts/sync-versions.mjs — do not edit. */
-declare const VERSION = "0.14.0";
+declare const VERSION = "0.15.0";
 
-export { APIError, type AccountServices, type AudioChunkEvent, type AudioDuckingParams, AuthenticationError, BadRequestError, type BaseTaskResult, type CompleteEvent, type CostEvent, type CostInfo, DEFAULT_TIMEOUT_MS, type DailyUsage, type DubbingLanguage, type DubbingParams, type DubbingResult, type DuckingResult, type ErrorEvent, GenerationError, type MusicMediaEntry, type MusicMuxEntry, type MusicTaskResult, type MusicTitle, PaymentRequiredError, RateLimitError, RequestTimeoutError, type Segment, type SegmentLabel, type SfxAudioFormat, type SfxError, type SfxMedia, type SfxResult, type SfxSegment, type SfxTask, SoniloClient, type SoniloClientOptions, SoniloError, type SoundOutputEntry, type SoundResult, type StreamEvent, TaskFailedError, TaskTimeoutError, type TextToMusicParams, type TextToSfxParams, type TitleEvent, type Track, TrialExhaustedError, type TrialQuota, type UnknownEvent, type UsageResponse, type UsageSummary, VERSION, type VideoInput, type VideoResult, type VideoToMusicParams, type VideoToSfxParams, type VideoToSoundParams, type VideoToVideoMusicParams, type VideoToVideoSfxParams, type VideoToVideoSoundParams, type WaitOptions, download, isAudioChunkEvent, isErrorEvent };
+export { APIError, type AccountServices, type AnalysisSegment, type AnalysisVariation, type AudioChunkEvent, type AudioDuckingParams, AuthenticationError, BadRequestError, type BaseTaskResult, type CompleteEvent, type CostEvent, type CostInfo, DEFAULT_TIMEOUT_MS, type DailyUsage, type DubbingLanguage, type DubbingParams, type DubbingResult, type DuckingResult, type ErrorEvent, GenerationError, type MusicMediaEntry, type MusicMuxEntry, type MusicTaskResult, type MusicTitle, PaymentRequiredError, RateLimitError, RequestTimeoutError, type Segment, type SegmentLabel, type SfxAudioFormat, type SfxError, type SfxMedia, type SfxResult, type SfxSegment, type SfxTask, SoniloClient, type SoniloClientOptions, SoniloError, type SoundOutputEntry, type SoundResult, type StreamEvent, TaskFailedError, TaskTimeoutError, type TextToMusicParams, type TextToSfxParams, type TitleEvent, type Track, TrialExhaustedError, type TrialQuota, type UnknownEvent, type UsageResponse, type UsageSummary, VERSION, type VideoAnalysisParams, type VideoAnalysisResult, type VideoInput, type VideoResult, type VideoToMusicParams, type VideoToSfxParams, type VideoToSoundParams, type VideoToVideoMusicParams, type VideoToVideoSfxParams, type VideoToVideoSoundParams, type WaitOptions, download, isAudioChunkEvent, isErrorEvent };

package/dist/index.js

@@ -750,8 +750,40 @@ var Dubbing = class {
   }
 };
 
+// src/resources/videoAnalysis.ts
+var VideoAnalysis = class {
+  constructor(client) {
+    this.client = client;
+  }
+  async submit(params) {
+    if (params.video === void 0 === (params.videoUrl === void 0)) {
+      throw new SoniloError("Provide exactly one of video or videoUrl");
+    }
+    const form = new FormData();
+    if (params.video !== void 0) {
+      const { blob, filename } = await toUploadBlob(params.video);
+      form.set("video", blob, filename);
+    } else {
+      form.set("video_url", params.videoUrl);
+    }
+    if (params.prompt !== void 0) form.set("prompt", params.prompt);
+    if (params.variantsNum !== void 0) {
+      form.set("variants_num", String(params.variantsNum));
+    }
+    const res = await this.client.request("/v1/video-analysis", {
+      method: "POST",
+      body: form
+    });
+    return await res.json();
+  }
+  async analyze(params, opts) {
+    const task = await this.submit(params);
+    return this.client.tasks.wait(task.task_id, opts);
+  }
+};
+
 // src/version.ts
-var VERSION = "0.14.0";
+var VERSION = "0.15.0";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.sonilo.com";
@@ -784,6 +816,7 @@ var SoniloClient = class {
     this.videoToVideoSound = new VideoToVideoSound(this);
     this.audioDucking = new AudioDucking(this);
     this.dubbing = new Dubbing(this);
+    this.videoAnalysis = new VideoAnalysis(this);
   }
   /**
    * Perform an authenticated request; throws a typed error on non-2xx.