@sogni-ai/sogni-client 5.69.1 → 5.71.0

package/src/Projects/createJobRequestMessage.ts

@@ -1653,6 +1653,23 @@ function applyVideoParams(
   rejectRetiredOutputScale(params);
   validateMinimaxH3Params(params);
   const keyFrame: Record<string, any> = { ...inputKeyframe };
+  if (params.referenceVideoCompression !== undefined) {
+    if (!['none', 'vpack'].includes(params.referenceVideoCompression)) {
+      throw new Error('referenceVideoCompression must be none or vpack.');
+    }
+    if (params.referenceVideoCompression === 'vpack') {
+      if (
+        !isMinimaxH3ReferenceModel(params.modelId) ||
+        params.modelId.endsWith('_2stage') ||
+        !getMinimaxH3ReferenceVideoSlots(params).length
+      ) {
+        throw new Error(
+          'VPack requires an uploaded reference video on a one-stage MiniMax H3 Reference to Video model.'
+        );
+      }
+      keyFrame.referenceVideoCompression = 'vpack';
+    }
+  }
   if (params.referenceImage) {
     keyFrame.hasReferenceImage = true;
   }

package/src/Projects/index.ts

@@ -394,10 +394,39 @@ export type ProjectStatusSnapshot = Partial<
   finished: boolean;
   workerJobs: RawProject['workerJobs'];
   completedWorkerJobs: RawProject['completedWorkerJobs'];
+  /** For a failed project: why, as its owner was told (status-only records keep it for a day). */
+  failure?: ProjectFailure;
 };
 
 const IN_FLIGHT_LOOKUP_STATUSES: ReadonlySet<string> = new Set(['pending', 'queued', 'processing']);
 
+/** The server's failure explanation, its string fields only; null when it has none. */
+function projectFailure(value: unknown): ProjectFailure | null {
+  if (!value || typeof value !== 'object') return null;
+  const record = value as Record<string, unknown>;
+  const failure: ProjectFailure = {};
+  for (const key of ['code', 'category', 'message'] as const) {
+    if (typeof record[key] === 'string' && record[key]) failure[key] = record[key] as string;
+  }
+  return Object.keys(failure).length ? failure : null;
+}
+
+/**
+ * Why a failed project failed, as its owner was told when it did: the provider's
+ * code, Sogni's category and the public message (the `jobError` event's
+ * `vendorErrorCode`, `vendorFailureCategory` and `error_message`). Kept with the
+ * project's status for a day, so a client that reconnects, or follows the
+ * project from another app, can say why it failed.
+ */
+export interface ProjectFailure {
+  /** The provider's error code, e.g. `OutputAudioSensitiveContentDetected.PolicyViolation`. */
+  code?: string;
+  /** Sogni's category for it, e.g. `content_policy`, `vendor_transient`, `timeout`. */
+  category?: string;
+  /** The message shown to the account when it failed. */
+  message?: string;
+}
+
 /**
  * One render of a project returned by {@link ProjectsApi.getResult}.
  */
@@ -444,6 +473,8 @@ export interface ProjectResult {
    * did not report one.
    */
   waitingReason?: WaitingReason | null;
+  /** For a failed project: why, as its owner was told. Absent when the server recorded no explanation. */
+  failure?: ProjectFailure;
   jobs: ProjectResultJob[];
 }
 
@@ -1081,6 +1112,9 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     if (data.vendorFailureCategory) {
       error.vendorFailureCategory = data.vendorFailureCategory;
     }
+    if (typeof data.vendorErrorCode === 'string' && data.vendorErrorCode) {
+      error.vendorErrorCode = data.vendorErrorCode;
+    }
     if (data.subscriptionLimit) {
       error.subscriptionLimit = true;
       if (data.requiredPlans) error.requiredPlans = data.requiredPlans;
@@ -2633,6 +2667,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     // The stored record's model carries its media type even though ProjectModel does not declare it.
     const recordType = (snapshot.model as { type?: unknown } | undefined)?.type;
     const projectType = typeof recordType === 'string' ? recordType : undefined;
+    const failure = projectFailure(snapshot.failure);
     const jobs: ProjectResultJob[] = [];
     const seen = new Set<string>();
     for (const job of [...(snapshot.completedWorkerJobs || []), ...(snapshot.workerJobs || [])]) {
@@ -2684,6 +2719,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
       finished: snapshot.finished,
       ...(modelId ? { modelId } : {}),
       ...(snapshot.waitingReason !== undefined ? { waitingReason: snapshot.waitingReason } : {}),
+      ...(failure ? { failure } : {}),
       jobs
     };
   }

package/src/Projects/types/index.ts

@@ -717,6 +717,8 @@ export interface VideoProjectParams extends BaseProjectParams {
    * pricing and job admission. Omit this field when duration is unavailable.
    */
   referenceVideoDurations?: number[];
+  /** Opt-in VPack compression for one-stage MiniMax H3 reference video. Omitted/none preserves the original reference tokens. */
+  referenceVideoCompression?: 'none' | 'vpack';
   /**
    * Inpaint mask IMAGE for distilled LTX 2.5 or LTX 2.3 v2v inpaint workflows.
    * White pixels mark the region to regenerate. Maps to jobKey 'referenceMask'.

package/src/index.ts

@@ -108,6 +108,7 @@ import type {
   ListRecentProjectsOptions,
   ProjectLookupStatus,
   ProjectResolution,
+  ProjectFailure,
   ProjectResult,
   ProjectResultJob,
   ProjectStatusSnapshot,
@@ -469,6 +470,7 @@ export type {
   ProjectLookupStatus,
   ProjectRecoverySnapshot,
   ProjectResolution,
+  ProjectFailure,
   ProjectResult,
   ProjectResultJob,
   ProjectStatusSnapshot,

package/src/types/ErrorData.ts

@@ -12,6 +12,15 @@ interface ErrorData {
    * with a generic failure message.
    */
   vendorFailureCategory?: string;
+  /**
+   * The provider's own error code for an external generation failure, when it
+   * gave one, e.g. `OutputAudioSensitiveContentDetected.PolicyViolation` (the
+   * provider flagged the soundtrack it generated, usually as possibly matching
+   * copyrighted audio) or `OutputVideoSensitiveContentDetected` (the picture).
+   * Lets an app tell kinds of refusal apart within one category without
+   * reading the message.
+   */
+  vendorErrorCode?: string;
   /**
    * Discriminator set to `true` when this render-path error is a subscription
    * FEATURE-gate denial (socket error code 4081). The four fields below are

package/src/version.ts

@@ -1,3 +1,3 @@
 // AUTO-GENERATED by scripts/generate-version.mjs — do not edit.
 // Source of truth: package.json version.
-export const LIB_VERSION = '5.69.1';
+export const LIB_VERSION = '5.71.0';