@sogni-ai/sogni-client 4.0.0-alpha.21 → 4.0.0-alpha.22

package/src/Projects/types/index.ts

@@ -8,12 +8,20 @@ export interface SupportedModel {
   id: string;
   name: string;
   SID: number;
+  /**
+   * Media type produced by this model: 'image' or 'video'
+   */
+  media: 'image' | 'video';
 }
 
 export interface AvailableModel {
   id: string;
   name: string;
   workerCount: number;
+  /**
+   * Media type produced by this model: 'image' or 'video'
+   */
+  media: 'image' | 'video';
 }
 
 export interface SizePreset {
@@ -29,15 +37,18 @@ export type { Sampler, Scheduler };
 
 export { SupportedSamplers, SupportedSchedulers };
 
-export type OutputFormat = 'png' | 'jpg';
-
-export type InputImage = File | Buffer | Blob | boolean;
+export type ImageOutputFormat = 'png' | 'jpg';
+export type VideoOutputFormat = 'mp4';
 
-export interface ProjectParams {
+export interface BaseProjectParams {
   /**
    * ID of the model to use, available models are available in the `availableModels` property of the `ProjectsApi` instance.
    */
   modelId: string;
+  /**
+   * Number of media files to generate. Depending on project type, this can be number of images or number of videos.
+   */
+  numberOfMedia: number;
   /**
    * Prompt for what to be created
    */
@@ -59,7 +70,7 @@ export interface ProjectParams {
    */
   guidance: number;
   /**
-   * Override current network type. Default value can be read from `client.account.currentAccount.network`
+   * Override current network type. Default value can be read from `sogni.account.currentAccount.network`
    */
   network?: SupernetType;
   /**
@@ -72,35 +83,89 @@ export interface ProjectParams {
    */
   seed?: number;
   /**
-   * Number of images to generate
+   * Select which tokens to use for the project.
+   * If not specified, the Sogni token will be used.
+   */
+  tokenType?: TokenType;
+}
+
+export type InputMedia = File | Buffer | Blob | boolean;
+
+/**
+ * Video-specific parameters for video workflows (t2v, i2v, s2v, animate).
+ * Only applicable when using video models like wan_v2.2-14b-fp8_t2v.
+ * Includes frame count, fps, shift, and reference assets (image, audio, video).
+ */
+export interface VideoProjectParams extends BaseProjectParams {
+  type: 'video';
+  /**
+   * Number of frames to generate
+   */
+  frames?: number;
+  /**
+   * Frames per second for output video
    */
-  numberOfImages: number;
+  fps?: number;
+  /**
+   * Shift parameter for video diffusion models
+   */
+  shift?: number;
+  /**
+   * Reference image for WAN video workflows.
+   * Maps to: startImage (i2v), characterImage (animate), referenceImage (s2v)
+   */
+  referenceImage?: InputMedia;
+  /**
+   * Optional end image for i2v interpolation workflows.
+   * When provided with referenceImage, the video will interpolate between the two images.
+   */
+  referenceImageEnd?: InputMedia;
+  /**
+   * Reference audio for s2v (sound-to-video) workflows.
+   */
+  referenceAudio?: InputMedia;
+  /**
+   * Reference video for animate workflows.
+   * Maps to: drivingVideo (animate-move), sourceVideo (animate-replace)
+   */
+  referenceVideo?: InputMedia;
+  /**
+   * Output video width. Only used if `sizePreset` is "custom"
+   */
+  width?: number;
+  /**
+   * Output video height. Only used if `sizePreset` is "custom"
+   */
+  height?: number;
+  /**
+   * Output video format. For now only 'mp4' is supported, defaults to 'mp4'.
+   */
+  outputFormat?: VideoOutputFormat;
+}
+
+export interface ImageProjectParams extends BaseProjectParams {
+  type: 'image';
   /**
-   * Generate images based on the starting image.
+   * Number of previews to generate. Note that previews affect project cost
+   */
+  numberOfPreviews?: number;
+  /**
+   * Starting image for img2img workflows.
    * Supported types:
    * `File` - file object from input[type=file]
    * `Buffer` - Node.js buffer object with image data
    * `Blob` - blob object with image data
    * `true` - indicates that the image is already uploaded to the server
    */
-  startingImage?: InputImage;
+  startingImage?: InputMedia;
   /**
    * How strong effect of starting image should be. From 0 to 1, default 0.5
    */
   startingImageStrength?: number;
   /**
    * Context images for Flux Kontext model. Flux Kontext support up to 2 context images.
-   * Supported types:
-   * `File` - file object from input[type=file]
-   * `Buffer` - Node.js buffer object with image data
-   * `Blob` - blob object with image data
-   * `true` - indicates that the image is already uploaded to the server
-   */
-  contextImages?: InputImage[];
-  /**
-   * Number of previews to generate. Note that previews affect project cost\
    */
-  numberOfPreviews?: number;
+  contextImages?: InputMedia[];
   /**
    * Scheduler to use
    */
@@ -111,7 +176,7 @@ export interface ProjectParams {
   scheduler?: Scheduler;
   /**
    * Size preset ID to use. You can query available size presets
-   * from `client.projects.sizePresets(network, modelId)`
+   * from `sogni.projects.sizePresets(network, modelId)`
    */
   sizePreset?: 'custom' | string;
   /**
@@ -127,25 +192,58 @@ export interface ProjectParams {
    */
   controlNet?: ControlNetParams;
   /**
-   * Select which tokens to use for the project.
-   * If not specified, the Sogni token will be used.
-   */
-  tokenType?: TokenType;
-  /**
-   * Output image format. Can be 'png' or 'jpg'.
-   * If not specified, 'png' will be used.
+   * Output format. Can be 'png' or 'jpg'. Defaults to 'png'.
    */
-  outputFormat?: OutputFormat;
+  outputFormat?: ImageOutputFormat;
 }
 
+export type ProjectParams = ImageProjectParams | VideoProjectParams;
+
+export function isVideoParams(params: ProjectParams): params is VideoProjectParams {
+  return params.type === 'video';
+}
+
+export function isImageParams(params: ProjectParams): params is ImageProjectParams {
+  return params.type === 'image';
+}
+
+/**
+ * Supported audio formats
+ */
+export type AudioFormat = 'm4a' | 'mp3' | 'wav';
+
+/**
+ * Supported video formats
+ */
+export type VideoFormat = 'mp4' | 'mov';
+
+/**
+ * Parameters for image asset URL requests (upload/download)
+ */
 export type ImageUrlParams = {
   imageId: string;
   jobId: string;
-  type: 'preview' | 'complete' | 'startingImage' | 'cnImage' | 'contextImage1' | 'contextImage2';
-  // This seems to be unused currently
+  type:
+    | 'preview'
+    | 'complete'
+    | 'startingImage'
+    | 'cnImage'
+    | 'contextImage1'
+    | 'contextImage2'
+    | 'referenceImage'
+    | 'referenceImageEnd';
   startContentType?: string;
 };
 
+/**
+ * Parameters for media asset URL requests (video/audio upload/download)
+ */
+export type MediaUrlParams = {
+  id?: string;
+  jobId: string;
+  type: 'complete' | 'preview' | 'referenceAudio' | 'referenceVideo';
+};
+
 export interface EstimateRequest {
   /**
    * Network to use. Can be 'fast' or 'relaxed'
@@ -223,3 +321,16 @@ export interface CostEstimation {
 }
 
 export type EnhancementStrength = 'light' | 'medium' | 'heavy';
+
+/**
+ * Video workflow types for WAN models
+ */
+export type VideoWorkflowType = 't2v' | 'i2v' | 's2v' | 'animate-move' | 'animate-replace' | null;
+
+export type AssetRequirement = 'required' | 'optional' | 'forbidden';
+
+export type VideoAssetKey =
+  | 'referenceImage'
+  | 'referenceImageEnd'
+  | 'referenceAudio'
+  | 'referenceVideo';

package/src/Projects/utils.ts

@@ -1,4 +1,4 @@
-import { EnhancementStrength } from './types';
+import { AssetRequirement, EnhancementStrength, VideoAssetKey, VideoWorkflowType } from './types';
 
 export function getEnhacementStrength(strength: EnhancementStrength): number {
   switch (strength) {
@@ -10,3 +10,68 @@ export function getEnhacementStrength(strength: EnhancementStrength): number {
       return 0.35;
   }
 }
+
+/**
+ * Check if a model ID is for a video workflow.
+ * This is consistent with the `media` property returned by the models list API.
+ * Video models produce MP4 output; image models produce PNG/JPG output.
+ */
+export function isVideoModel(modelId: string): boolean {
+  return modelId.startsWith('wan_');
+}
+
+/**
+ * Get the video workflow type from a model ID.
+ * Returns null for non-video models.
+ */
+export function getVideoWorkflowType(modelId: string): VideoWorkflowType {
+  if (!modelId || !modelId.startsWith('wan_')) return null;
+  if (modelId.includes('_i2v')) return 'i2v';
+  if (modelId.includes('_s2v')) return 's2v';
+  if (modelId.includes('_animate-move')) return 'animate-move';
+  if (modelId.includes('_animate-replace')) return 'animate-replace';
+  if (modelId.includes('_t2v')) return 't2v';
+  return null;
+}
+
+/**
+ * Asset requirements for each video workflow type.
+ * - required: Must be provided
+ * - optional: Can be provided
+ * - forbidden: Must NOT be provided
+ */
+export const VIDEO_WORKFLOW_ASSETS: Record<
+  NonNullable<VideoWorkflowType>,
+  Record<VideoAssetKey, AssetRequirement>
+> = {
+  t2v: {
+    referenceImage: 'forbidden',
+    referenceImageEnd: 'forbidden',
+    referenceAudio: 'forbidden',
+    referenceVideo: 'forbidden'
+  },
+  i2v: {
+    referenceImage: 'required',
+    referenceImageEnd: 'optional',
+    referenceAudio: 'forbidden',
+    referenceVideo: 'forbidden'
+  },
+  s2v: {
+    referenceImage: 'required',
+    referenceAudio: 'required',
+    referenceImageEnd: 'forbidden',
+    referenceVideo: 'forbidden'
+  },
+  'animate-move': {
+    referenceImage: 'required',
+    referenceVideo: 'required',
+    referenceImageEnd: 'forbidden',
+    referenceAudio: 'forbidden'
+  },
+  'animate-replace': {
+    referenceImage: 'required',
+    referenceVideo: 'required',
+    referenceImageEnd: 'forbidden',
+    referenceAudio: 'forbidden'
+  }
+};

package/src/index.ts

@@ -14,12 +14,18 @@ import Job, { JobStatus } from './Projects/Job';
 import Project, { ProjectStatus } from './Projects/Project';
 import {
   AvailableModel,
-  OutputFormat,
+  ImageProjectParams,
+  ImageOutputFormat,
   ProjectParams,
   Sampler,
   Scheduler,
   SupportedSamplers,
-  SupportedSchedulers
+  SupportedSchedulers,
+  VideoProjectParams,
+  AudioFormat,
+  VideoFormat,
+  VideoOutputFormat,
+  VideoWorkflowType
 } from './Projects/types';
 // Stats API
 import StatsApi from './Stats';
@@ -30,18 +36,24 @@ import { CookieAuthManager, TokenAuthData, TokenAuthManager } from './lib/AuthMa
 import { MeData } from './Account/types';
 
 export type {
+  AudioFormat,
   AvailableModel,
   ErrorData,
+  ImageProjectParams,
+  ImageOutputFormat,
   JobStatus,
   Logger,
   LogLevel,
-  OutputFormat,
   ProjectParams,
   ProjectStatus,
   Sampler,
   SupernetType,
   Scheduler,
-  TokenType
+  TokenType,
+  VideoFormat,
+  VideoOutputFormat,
+  VideoProjectParams,
+  VideoWorkflowType
 };
 
 export { ApiError, CurrentAccount, Job, Project, SupportedSamplers, SupportedSchedulers };

package/src/lib/AuthManager/TokenAuthManager.ts

@@ -46,7 +46,6 @@ class TokenAuthManager extends AuthManagerBase<TokenAuthData | null> {
       const { expiresAt } = decodeToken(token);
       if (expiresAt > new Date()) {
         this._updateTokens({ token, refreshToken });
-        this.emit('updated', true);
         return;
       }
     }
@@ -55,7 +54,6 @@ class TokenAuthManager extends AuthManagerBase<TokenAuthData | null> {
     const { expiresAt: refreshExpiresAt } = decodeRefreshToken(refreshToken);
     this._refreshTokenExpiresAt = refreshExpiresAt;
     await this._renewTokenSafe();
-    this.emit('updated', true);
   }
 
   clear() {