@sogni-ai/sogni-client 5.84.0 → 5.84.2

package/dist-esm/Projects/utils/imageUploadBody.js

@@ -0,0 +1,85 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { ApiError } from '../../ApiClient/index.js';
+/**
+ * Refuse an image-slot upload whose contents are text instead of image bytes.
+ *
+ * An image slot that receives text instead of an image (a file path string,
+ * a fetched HTML page, or base64 text) cannot be decoded, so the job fails
+ * after it has been submitted. Checking the leading bytes here turns that
+ * into an error that names the slot, before any upload URL, upload or job
+ * request.
+ *
+ * Only contents that cannot be an image are refused: a `data:` URL, an HTML
+ * page, base64 text, or a string that is not markup. Image bytes, SVG markup
+ * and anything this check does not recognise upload as before.
+ */
+export function assertImageUploadBody(file, slot) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const found = yield describeTextBody(file);
+        if (!found)
+            return;
+        throw new ApiError(400, {
+            status: 'error',
+            errorCode: 0,
+            message: `${slot} is not image data: ${found}. Upload the image file itself.`
+        });
+    });
+}
+/** Enough leading bytes for an HTML doctype after a byte-order mark and some whitespace. */
+const SNIFF_BYTES = 64;
+/** Sixteen base64 characters: no binary image header is made only of them. */
+const BASE64_HEAD = /^[A-Za-z0-9+/]{16}/;
+const DATA_URL_HEAD = /^data:/i;
+/** UTF-8 byte-order mark, read either as one character or as its three bytes. */
+const HTML_HEAD = /^(?:|\xef\xbb\xbf)?\s*<(?:!doctype\s+html|html[\s>])/i;
+const MARKUP_HEAD = /^(?:|\xef\xbb\xbf)?\s*</;
+function describeTextBody(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        if (typeof file === 'string') {
+            const head = file.slice(0, SNIFF_BYTES);
+            // SVG markup is text and still uploads; any other string is not an image.
+            return (_a = describeHead(head)) !== null && _a !== void 0 ? _a : (MARKUP_HEAD.test(head) ? null : 'it is a string, not the file');
+        }
+        const bytes = yield leadingBytes(file);
+        return bytes ? describeHead(String.fromCharCode(...bytes)) : null;
+    });
+}
+function leadingBytes(file) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            if (typeof Blob !== 'undefined' && file instanceof Blob) {
+                return new Uint8Array(yield file.slice(0, SNIFF_BYTES).arrayBuffer());
+            }
+            if (ArrayBuffer.isView(file)) {
+                return new Uint8Array(file.buffer, file.byteOffset, Math.min(file.byteLength, SNIFF_BYTES));
+            }
+            if (file instanceof ArrayBuffer) {
+                return new Uint8Array(file, 0, Math.min(file.byteLength, SNIFF_BYTES));
+            }
+        }
+        catch (_a) {
+            // A file that can no longer be read fails at the upload, as it always has.
+        }
+        return null;
+    });
+}
+function describeHead(head) {
+    if (DATA_URL_HEAD.test(head))
+        return 'its contents are a data: URL';
+    if (HTML_HEAD.test(head))
+        return 'its contents are an HTML page';
+    // GIF's signature is letters and digits, and its size bytes can be too.
+    if (!head.startsWith('GIF8') && BASE64_HEAD.test(head))
+        return 'its contents are base64 text';
+    return null;
+}
+//# sourceMappingURL=imageUploadBody.js.map

package/dist-esm/Projects/utils/imageUploadBody.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"imageUploadBody.js","sourceRoot":"","sources":["../../../src/Projects/utils/imageUploadBody.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD;;;;;;;;;;;;GAYG;AACH,MAAM,UAAgB,qBAAqB,CAAC,IAAa,EAAE,IAAY;;QACrE,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK;YAAE,OAAO;QACnB,MAAM,IAAI,QAAQ,CAAC,GAAG,EAAE;YACtB,MAAM,EAAE,OAAO;YACf,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,GAAG,IAAI,uBAAuB,KAAK,iCAAiC;SAC9E,CAAC,CAAC;IACL,CAAC;CAAA;AAED,4FAA4F;AAC5F,MAAM,WAAW,GAAG,EAAE,CAAC;AACvB,8EAA8E;AAC9E,MAAM,WAAW,GAAG,oBAAoB,CAAC;AACzC,MAAM,aAAa,GAAG,SAAS,CAAC;AAChC,iFAAiF;AACjF,MAAM,SAAS,GAAG,wDAAwD,CAAC;AAC3E,MAAM,WAAW,GAAG,0BAA0B,CAAC;AAE/C,SAAe,gBAAgB,CAAC,IAAa;;;QAC3C,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC;YACxC,0EAA0E;YAC1E,OAAO,MAAA,YAAY,CAAC,IAAI,CAAC,mCAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,8BAA8B,CAAC,CAAC;QAChG,CAAC;QACD,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,CAAC;QACvC,OAAO,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACpE,CAAC;CAAA;AAED,SAAe,YAAY,CAAC,IAAa;;QACvC,IAAI,CAAC;YACH,IAAI,OAAO,IAAI,KAAK,WAAW,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;gBACxD,OAAO,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YACxE,CAAC;YACD,IAAI,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YAC9F,CAAC;YACD,IAAI,IAAI,YAAY,WAAW,EAAE,CAAC;gBAChC,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QAAC,WAAM,CAAC;YACP,2EAA2E;QAC7E,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CAAA;AAED,SAAS,YAAY,CAAC,IAAY;IAChC,IAAI,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,8BAA8B,CAAC;IACpE,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,+BAA+B,CAAC;IACjE,wEAAwE;IACxE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,8BAA8B,CAAC;IAC9F,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist-esm/version.js

@@ -1,4 +1,4 @@
 // AUTO-GENERATED by scripts/generate-version.mjs — do not edit.
 // Source of truth: package.json version.
-export const LIB_VERSION = '5.84.0';
+export const LIB_VERSION = '5.84.2';
 //# sourceMappingURL=version.js.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "5.84.0",
+  "version": "5.84.2",
   "engines": {
     "node": ">=22"
   },
@@ -92,6 +92,7 @@
     "test:prompt-expansion": "npm run build && node scripts/check-prompt-expansion-transport.cjs",
     "test:priority-mode": "npm run build && node scripts/check-priority-mode.cjs && node scripts/check-priority-capability.cjs",
     "test:reference-content-types": "npm run build && node scripts/check-reference-content-types.cjs",
+    "test:image-upload-body": "npm run build && node scripts/check-image-upload-body.cjs",
     "test:minimax-h3-audio-policy": "node scripts/check-minimax-h3-source-audio-policy.cjs",
     "test:minimax-h3-balanced": "npm run build && node scripts/check-minimax-h3-balanced.cjs",
     "test:minimax-h3-two-stage": "npm run build && node scripts/check-minimax-h3-two-stage.cjs",
@@ -158,7 +159,7 @@
   "homepage": "https://github.com/Sogni-AI/sogni-client#readme",
   "dependencies": {
     "@simplewebauthn/browser": "14.0.0",
-    "@sogni-ai/sogni-protocol": "1.0.0-alpha.62",
+    "@sogni-ai/sogni-protocol": "1.0.0-alpha.63",
     "@types/js-cookie": "^3.0.6",
     "@types/lodash": "^4.17.23",
     "@types/ws": "^8.5.13",

package/src/Chat/_hostedToolsManifest.generated.ts

@@ -806,7 +806,7 @@ export const SOGNI_HOSTED_TOOLS_MANIFEST: unknown = {
       "type": "function",
       "function": {
         "name": "upscale_video",
-        "description": "Upscale an existing video to 1080p, 1440p or 2160p (4K) with recommended RelayVSR, or to 1080p or 1440p with FlashVSR. This is promptless, deterministic enhancement, not a generative edit: it keeps every source frame, the exact frame rate, the full aspect ratio, and the original audio, and it never changes content, trims, crops, restyles, or interpolates frames. Use it when the user asks to upscale, enlarge, sharpen, or increase the resolution of an uploaded or previously generated video, or wants an HD, 1080p, 1440p, 2K, or 4K copy of it. Do not use it to create, restyle, extend, or edit a video; when the user explicitly asks a generative model such as Seedance to re-render the clip, use video_to_video. Explicitly set model to relayvsr for new upscales. Use flashvsr when the user requests FlashVSR or specifically wants its detailPreference, processingSpeed or seed controls. Omitted model retains FlashVSR for compatibility. With FlashVSR the output is at most twice the source size, so 1080p needs a source whose short edge is 540-768px and 1440p needs 720-768px, and the source can be at most about 1344x768 pixels (768x1344 in portrait). With RelayVSR the output is at most twice the source size for a source up to 1920x1080 pixels (1080x1920 in portrait), or four times for a source up to 1344x768 (768x1344 in portrait), so 2160p needs a source whose short edge is 540-768px or exactly 1080px, and the output's long edge can be at most 3840px. The source must also be 1-60 fps and at most 100 MB. The server sets the maximum clip length and rejects a source that is too long; never quote a length limit yourself, and if the tool reports that rejection, relay that error to the user. FlashVSR cannot produce 4K or any size above 1440p, so a 4K request always uses relayvsr. Nothing here produces a size above 2160p; when the user asks for one, say so and offer 2160p. Each upscale costs credits based on the source video's size and length. With FlashVSR, optional detailPreference (stable or sharper), processingSpeed (stable or faster), and seed tune the result; omit them unless the user asks, and none of them changes the price. RelayVSR refuses all three.",
+        "description": "Upscale an existing video to 1080p, 1440p or 2160p (4K) with recommended RelayVSR, or to 1080p or 1440p with FlashVSR. This is promptless, deterministic enhancement, not a generative edit: it keeps every source frame, the exact frame rate, the full aspect ratio, and the original audio, and it never changes content, trims, crops, restyles, or interpolates frames. Use it when the user asks to upscale, enlarge, sharpen, or increase the resolution of an uploaded or previously generated video, or wants an HD, 1080p, 1440p, 2K, or 4K copy of it. Do not use it to create, restyle, extend, or edit a video; when the user explicitly asks a generative model such as Seedance to re-render the clip, use video_to_video. Explicitly set model to relayvsr for new upscales. Use flashvsr when the user requests FlashVSR or specifically wants its detailPreference, processingSpeed or seed controls. Omitted model retains FlashVSR for compatibility. With FlashVSR the output is at most twice the source size, so 1080p needs a source whose short edge is 540-768px and 1440p needs 720-768px, and the source can be at most about 1344x768 pixels (768x1344 in portrait). With RelayVSR the output is at most twice the source size for a source up to 1920x1088 pixels (1088x1920 in portrait), or four times for a source up to 1344x768 (768x1344 in portrait), so 2160p needs a source whose short edge is 540-768px or 1080-1088px, and the output's long edge can be at most 3840px. The source must also be 1-60 fps and at most 100 MB. The server sets the maximum clip length and rejects a source that is too long; never quote a length limit yourself, and if the tool reports that rejection, relay that error to the user. FlashVSR cannot produce 4K or any size above 1440p, so a 4K request always uses relayvsr. Nothing here produces a size above 2160p; when the user asks for one, say so and offer 2160p. Each upscale costs credits based on the source video's size and length. With FlashVSR, optional detailPreference (stable or sharper), processingSpeed (stable or faster), and seed tune the result; omit them unless the user asks, and none of them changes the price. RelayVSR refuses all three.",
         "parameters": {
           "type": "object",
           "properties": {

package/src/Projects/index.ts

@@ -108,6 +108,7 @@ import {
   usesReferenceMask
 } from './utils/index.js';
 import { getFileContentType } from './utils/fileContentType.js';
+import { assertImageUploadBody } from './utils/imageUploadBody.js';
 import { imageLayersFromResult } from './utils/imageLayers.js';
 import { TokenType } from '../types/token.js';
 import type { JobProvenance } from './types/JobProvenance.js';
@@ -3315,6 +3316,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, 'Guide image');
     const contentType = getFileContentType(file);
     if (await this._bindSavedUpload(file, contentType, { projectId, type: 'startingImage' }))
       return imageId;
@@ -3349,6 +3351,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, 'ControlNet image');
     const contentType = getFileContentType(file);
     if (await this._bindSavedUpload(file, contentType, { projectId, type: 'cnImage' }))
       return imageId;
@@ -3404,6 +3407,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, `Context image ${imageIndex}`);
     const contentType = getFileContentType(file);
     if (
       await this._bindSavedUpload(file, contentType, {
@@ -3454,6 +3458,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, `Keyframe image ${slot}`);
     const contentType = getFileContentType(file);
     if (await this._bindSavedUpload(file, contentType, { projectId, type })) return imageId;
     assertSession();
@@ -3490,6 +3495,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, 'Reference image');
     const contentType = getFileContentType(file);
     if (await this._bindSavedUpload(file, contentType, { projectId, type: 'referenceImage' }))
       return imageId;
@@ -3528,6 +3534,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, 'Reference mask');
     const contentType = getFileContentType(file);
     if (await this._bindSavedUpload(file, contentType, { projectId, type: 'referenceMask' }))
       return imageId;
@@ -3566,6 +3573,7 @@ class ProjectsApi extends ApiGroup<ProjectApiEvents> {
     const assertSession =
       this._preparingSessions.get(projectId) ?? captureRequestSession(this.client.auth);
     assertSession();
+    await assertImageUploadBody(file, 'End reference image');
     const contentType = getFileContentType(file);
     if (await this._bindSavedUpload(file, contentType, { projectId, type: 'referenceImageEnd' }))
       return imageId;

package/src/Projects/utils/imageUploadBody.ts

@@ -0,0 +1,68 @@
+import { ApiError } from '../../ApiClient/index.js';
+
+/**
+ * Refuse an image-slot upload whose contents are text instead of image bytes.
+ *
+ * An image slot that receives text instead of an image (a file path string,
+ * a fetched HTML page, or base64 text) cannot be decoded, so the job fails
+ * after it has been submitted. Checking the leading bytes here turns that
+ * into an error that names the slot, before any upload URL, upload or job
+ * request.
+ *
+ * Only contents that cannot be an image are refused: a `data:` URL, an HTML
+ * page, base64 text, or a string that is not markup. Image bytes, SVG markup
+ * and anything this check does not recognise upload as before.
+ */
+export async function assertImageUploadBody(file: unknown, slot: string): Promise<void> {
+  const found = await describeTextBody(file);
+  if (!found) return;
+  throw new ApiError(400, {
+    status: 'error',
+    errorCode: 0,
+    message: `${slot} is not image data: ${found}. Upload the image file itself.`
+  });
+}
+
+/** Enough leading bytes for an HTML doctype after a byte-order mark and some whitespace. */
+const SNIFF_BYTES = 64;
+/** Sixteen base64 characters: no binary image header is made only of them. */
+const BASE64_HEAD = /^[A-Za-z0-9+/]{16}/;
+const DATA_URL_HEAD = /^data:/i;
+/** UTF-8 byte-order mark, read either as one character or as its three bytes. */
+const HTML_HEAD = /^(?:|\xef\xbb\xbf)?\s*<(?:!doctype\s+html|html[\s>])/i;
+const MARKUP_HEAD = /^(?:|\xef\xbb\xbf)?\s*</;
+
+async function describeTextBody(file: unknown): Promise<string | null> {
+  if (typeof file === 'string') {
+    const head = file.slice(0, SNIFF_BYTES);
+    // SVG markup is text and still uploads; any other string is not an image.
+    return describeHead(head) ?? (MARKUP_HEAD.test(head) ? null : 'it is a string, not the file');
+  }
+  const bytes = await leadingBytes(file);
+  return bytes ? describeHead(String.fromCharCode(...bytes)) : null;
+}
+
+async function leadingBytes(file: unknown): Promise<Uint8Array | null> {
+  try {
+    if (typeof Blob !== 'undefined' && file instanceof Blob) {
+      return new Uint8Array(await file.slice(0, SNIFF_BYTES).arrayBuffer());
+    }
+    if (ArrayBuffer.isView(file)) {
+      return new Uint8Array(file.buffer, file.byteOffset, Math.min(file.byteLength, SNIFF_BYTES));
+    }
+    if (file instanceof ArrayBuffer) {
+      return new Uint8Array(file, 0, Math.min(file.byteLength, SNIFF_BYTES));
+    }
+  } catch {
+    // A file that can no longer be read fails at the upload, as it always has.
+  }
+  return null;
+}
+
+function describeHead(head: string): string | null {
+  if (DATA_URL_HEAD.test(head)) return 'its contents are a data: URL';
+  if (HTML_HEAD.test(head)) return 'its contents are an HTML page';
+  // GIF's signature is letters and digits, and its size bytes can be too.
+  if (!head.startsWith('GIF8') && BASE64_HEAD.test(head)) return 'its contents are base64 text';
+  return null;
+}

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.84.0';
+export const LIB_VERSION = '5.84.2';