@sogni-ai/sogni-client 4.0.0-alpha.4 → 4.0.0-alpha.41

package/dist/Projects/index.d.ts

@@ -1,5 +1,5 @@
 import ApiGroup, { ApiConfig } from '../ApiGroup';
-import { AvailableModel, EnhancementStrength, EstimateRequest, ImageUrlParams, ProjectParams, SizePreset, SupportedModel } from './types';
+import { AvailableModel, EnhancementStrength, EstimateRequest, ImageUrlParams, MediaUrlParams, CostEstimation, ProjectParams, SizePreset, SupportedModel, VideoEstimateRequest } from './types';
 import Project from './Project';
 import { ProjectApiEvents } from './types/events';
 import { RawProject } from './types/RawProject';
@@ -10,11 +10,26 @@ declare class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     private projects;
     private _supportedModels;
     get availableModels(): AvailableModel[];
+    /**
+     * Check if a model produces video output using the cached models list.
+     * Uses the `media` property from the models API when available,
+     * falls back to model ID prefix check if models aren't loaded yet.
+     */
+    isVideoModelId(modelId: string): boolean;
     constructor(config: ApiConfig);
+    /**
+     * Retrieves a list of projects created and tracked by this SogniClient instance.
+     *
+     * Note: When a project is finished, it will be removed from this list after 30 seconds
+     *
+     * @return {Array} A copy of the array containing the tracked projects.
+     */
+    get trackedProjects(): Project[];
     private handleChangeNetwork;
     private handleSwarmModels;
     private handleJobState;
     private handleJobProgress;
+    private handleJobETA;
     private handleJobResult;
     private handleJobError;
     private handleProjectEvent;
@@ -28,10 +43,12 @@ declare class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     waitForModels(timeout?: number): Promise<AvailableModel[]>;
     /**
      * Send new project request to the network. Returns project instance which can be used to track
-     * progress and get resulting images.
+     * progress and get resulting images or videos.
      * @param data
      */
     create(data: ProjectParams): Promise<Project>;
+    private _processImageAssets;
+    private _processVideoAssets;
     /**
      * Get project by id, this API returns project data from the server only if the project is
      * completed or failed. If the project is still processing, it will throw 404 error.
@@ -50,35 +67,87 @@ declare class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     private uploadCNImage;
     private uploadContextImage;
     /**
-     * Estimate project cost
+     * Upload reference image for WAN video workflows
+     * @internal
      */
-    estimateCost({ network, tokenType, model, imageCount, stepCount, previewCount, cnEnabled, startingImageStrength, width, height, sizePreset, guidance, scheduler, contextImages }: EstimateRequest): Promise<{
-        token: string;
-        usd: string;
-    }>;
-    estimateEnhancementCost(strength: EnhancementStrength, tokenType?: TokenType): Promise<{
+    private uploadReferenceImage;
+    /**
+     * Upload reference image end for i2v interpolation
+     * @internal
+     */
+    private uploadReferenceImageEnd;
+    /**
+     * Upload reference audio for s2v workflows
+     * Supported formats: mp3, m4a, wav
+     * @internal
+     */
+    private uploadReferenceAudio;
+    /**
+     * Upload reference video for animate workflows
+     * Supported formats: mp4, mov
+     * @internal
+     */
+    private uploadReferenceVideo;
+    /**
+     * Estimate image project cost
+     */
+    estimateCost({ network, tokenType, model, imageCount, stepCount, previewCount, cnEnabled, startingImageStrength, width, height, sizePreset, guidance, sampler, contextImages }: EstimateRequest): Promise<CostEstimation>;
+    /**
+     * Estimate image enhancement cost
+     * @param strength
+     * @param tokenType
+     */
+    estimateEnhancementCost(strength: EnhancementStrength, tokenType?: TokenType): Promise<CostEstimation>;
+    /**
+     * Estimates the cost of generating a video based on the provided parameters.
+     *
+     * @param {VideoEstimateRequest} params - The parameters required for video cost estimation. This includes:
+     *   - tokenType: The type of token to be used for generation.
+     *   - model: The model to be used for video generation.
+     *   - width: The width of the video in pixels.
+     *   - height: The height of the video in pixels.
+     *   - frames: The total number of frames in the video.
+     *   - fps: The frames per second for the video.
+     *   - steps: Number of steps.
+     * @return {Promise<Object>} Returns an object containing the estimated costs for the video in different units:
+     *   - token: Cost in tokens.
+     *   - usd: Cost in USD.
+     *   - spark: Cost in Spark.
+     *   - sogni: Cost in Sogni.
+     */
+    estimateVideoCost(params: VideoEstimateRequest): Promise<{
         token: string;
         usd: string;
+        spark: string;
+        sogni: string;
     }>;
     /**
      * Get upload URL for image
      * @internal
-     * @param params
      */
     uploadUrl(params: ImageUrlParams): Promise<string>;
     /**
      * Get download URL for image
      * @internal
-     * @param params
      */
     downloadUrl(params: ImageUrlParams): Promise<string>;
+    /**
+     * Get upload URL for media (video/audio)
+     * @internal
+     */
+    mediaUploadUrl(params: MediaUrlParams): Promise<string>;
+    /**
+     * Get download URL for media (video/audio)
+     * @internal
+     */
+    mediaDownloadUrl(params: MediaUrlParams): Promise<string>;
     getSupportedModels(forceRefresh?: boolean): Promise<SupportedModel[]>;
     /**
      * Get supported size presets for the model and network. Size presets are cached for 10 minutes.
      *
      * @example
      * ```ts
-     * const presets = await client.projects.getSizePresets('fast', 'flux1-schnell-fp8');
+     * const presets = await sogni.projects.getSizePresets('fast', 'flux1-schnell-fp8');
      * console.log(presets);
      * ```
      *
@@ -95,11 +164,43 @@ declare class ProjectsApi extends ApiGroup<ProjectApiEvents> {
      * }[]>}
      */
     getSizePresets(network: SupernetType, modelId: string, forceRefresh?: boolean): Promise<SizePreset[]>;
+    /**
+     * Retrieves the video asset configuration for a given video model identifier.
+     * Validates whether the provided model ID corresponds to a video model. If it does,
+     * returns the appropriate video asset configuration based on the workflow type.
+     *
+     * @example Returned object for a model that implements image to video workflow:
+     * ```json
+     * {
+     *   "workflowType": "i2v",
+     *   "assets": {
+     *     "referenceImage": "required",
+     *     "referenceImageEnd": "optional",
+     *     "referenceAudio": "forbidden",
+     *     "referenceVideo": "forbidden"
+     *   }
+     * }
+     * ```
+     *
+     * @param {string} modelId - The identifier of the video model to retrieve the configuration for.
+     * @return {Object} The video asset configuration object where key is asset field and value is
+     * either `required`, `forbidden` or `optional`. Returns `null` if no rules defined for the model.
+     * @throws {ApiError} Throws an error if the provided model ID is not a video model.
+     */
+    getVideoAssetConfig(modelId: string): Promise<{
+        workflowType: null;
+        assets?: undefined;
+    } | {
+        workflowType: "t2v" | "i2v" | "s2v" | "animate-move" | "animate-replace";
+        assets: Record<import("./types").VideoAssetKey, import("./types").AssetRequirement>;
+    }>;
     /**
      * Get available models and their worker counts. Normally, you would get list once you connect
      * to the server, but you can also call this method to get the list of available models manually.
      * @param network
      */
     getAvailableModels(network: SupernetType): Promise<AvailableModel[]>;
+    getSamplers(modelId: string): Promise<("euler" | "euler_ancestral" | "heun" | "dpmpp_2m" | "dpmpp_2m_sde" | "dpmpp_sde" | "dpmpp_3m_sde" | "uni_pc" | "lcm" | "lms" | "dpm_2" | "dpm_2_ancestral" | "dpm_fast" | "dpm_adaptive" | "dpmpp_2s_ancestral" | "ddpm" | "ddim" | "uni_pc_bh2" | "res_multistep" | "res_multistep_cfg_pp")[] | ("euler" | "euler_ancestral" | "heun" | "dpmpp_2m" | "dpmpp_2m_sde" | "dpmpp_sde" | "dpmpp_3m_sde" | "uni_pc" | "lcm" | "lms" | "dpm_2" | "dpm_2_ancestral" | "dpm_fast" | "dpm_adaptive" | "dpmpp_2s_ancestral" | "ddpm" | "dfs_sd3" | "dpm_pp" | "dpm_pp_sde" | "dpm_pp_2m" | "euler_a" | "pndm_plms")[]>;
+    getSchedulers(modelId: string): Promise<("simple" | "normal" | "karras" | "exponential" | "sgm_uniform" | "ddim_uniform" | "beta" | "linear_quadratic" | "kl_optimal" | "ddim" | "leading" | "linear")[]>;
 }
 export default ProjectsApi;