@sogni-ai/expo-client 1.0.0-alpha.10

package/src/Projects/createJobRequestMessage.ts

@@ -0,0 +1,241 @@
+import { toControlNetRaw } from './ControlNet';
+import { AudioProjectParams, ImageProjectParams, ProjectParams, VideoProjectParams } from './types';
+import { calculateVideoFrames, isComfyModel } from './utils';
+
+/**
+ * Build the wire-level `jobRequest` payload from public ProjectParams.
+ *
+ * The template includes a lot of fields that look video/animation-specific
+ * because the server validates the full shape regardless of project type. We
+ * send everything verbatim and the server picks what it needs based on the
+ * model family.
+ */
+export default function createJobRequestMessage(
+  id: string,
+  params: ProjectParams
+): Record<string, unknown> {
+  const type = params.type ?? 'image';
+  switch (type) {
+    case 'video':
+      return buildVideoRequest(id, params as VideoProjectParams);
+    case 'audio':
+      return buildAudioRequest(id, params as AudioProjectParams);
+    case 'image':
+    default:
+      return buildImageRequest(id, params as ImageProjectParams);
+  }
+}
+
+function buildImageRequest(id: string, params: ImageProjectParams): Record<string, unknown> {
+  const keyFrame = baseKeyFrame(params);
+  if (isComfyModel(params.modelId)) {
+    if (params.sampler !== undefined) keyFrame.comfySampler = params.sampler;
+    if (params.scheduler !== undefined) keyFrame.comfyScheduler = params.scheduler;
+  } else {
+    if (params.sampler !== undefined) keyFrame.scheduler = params.sampler;
+    if (params.scheduler !== undefined) keyFrame.timeStepSpacing = params.scheduler;
+  }
+
+  const effectiveSizePreset =
+    params.sizePreset || (params.width && params.height ? 'custom' : undefined);
+  if (effectiveSizePreset) {
+    keyFrame.sizePreset = effectiveSizePreset;
+    if (effectiveSizePreset === 'custom' && params.width && params.height) {
+      keyFrame.width = params.width;
+      keyFrame.height = params.height;
+    }
+  }
+
+  if (params.startingImage) {
+    keyFrame.hasStartingImage = true;
+    keyFrame.strengthIsEnabled = true;
+    keyFrame.strength = 1 - (params.startingImageStrength ?? 0.5);
+  }
+
+  const contextImages = params.contextImages || [];
+  for (let i = 1; i <= 16; i += 1) {
+    keyFrame[`hasContextImage${i}`] = !!contextImages[i - 1];
+  }
+
+  if (params.controlNet) {
+    keyFrame.currentControlNetsJob = [toControlNetRaw(params.controlNet)];
+  }
+
+  return wrapJobRequest(id, keyFrame, params, {
+    previews: params.numberOfPreviews ?? 0,
+    outputFormat: params.outputFormat || 'png'
+  });
+}
+
+function buildVideoRequest(id: string, params: VideoProjectParams): Record<string, unknown> {
+  const keyFrame = baseKeyFrame(params);
+  keyFrame.comfySampler = params.sampler;
+  keyFrame.comfyScheduler = params.scheduler;
+
+  if (params.fps !== undefined) keyFrame.fps = params.fps;
+  if (params.frames !== undefined) {
+    keyFrame.frames = params.frames;
+  } else if (params.duration !== undefined) {
+    const fps = params.fps ?? 24;
+    keyFrame.frames = calculateVideoFrames(params.modelId, params.duration, fps);
+  }
+  if (params.shift !== undefined) keyFrame.shift = params.shift;
+  if (params.width && params.height) {
+    keyFrame.width = params.width;
+    keyFrame.height = params.height;
+  }
+  if (params.referenceImage) keyFrame.hasReferenceImage = true;
+  if (params.referenceImageEnd) keyFrame.hasReferenceImageEnd = true;
+  if (params.referenceAudio) keyFrame.hasReferenceAudio = true;
+  if (params.referenceVideo) keyFrame.hasReferenceVideo = true;
+  if (params.firstFrameStrength !== undefined) {
+    keyFrame.firstFrameStrength = params.firstFrameStrength;
+  }
+  if (params.lastFrameStrength !== undefined) {
+    keyFrame.lastFrameStrength = params.lastFrameStrength;
+  }
+
+  return wrapJobRequest(id, keyFrame, params, {
+    previews: 0,
+    outputFormat: params.outputFormat || 'mp4'
+  });
+}
+
+function buildAudioRequest(id: string, params: AudioProjectParams): Record<string, unknown> {
+  const keyFrame = baseKeyFrame(params);
+  // Audio models are all comfy
+  keyFrame.comfySampler = params.sampler;
+  keyFrame.comfyScheduler = params.scheduler;
+
+  if (params.duration !== undefined) keyFrame.duration = params.duration;
+  if (params.bpm !== undefined) keyFrame.bpm = params.bpm;
+  if (params.timesignature !== undefined) keyFrame.timesignature = params.timesignature;
+  if (params.language !== undefined) keyFrame.language = params.language;
+  if (params.lyrics !== undefined) keyFrame.lyrics = params.lyrics;
+  if (params.keyscale !== undefined) keyFrame.keyscale = params.keyscale;
+  if (params.composerMode !== undefined) keyFrame.composerMode = params.composerMode;
+  if (params.promptStrength !== undefined) keyFrame.promptStrength = params.promptStrength;
+  if (params.creativity !== undefined) keyFrame.creativity = params.creativity;
+  if (params.shift !== undefined) keyFrame.shift = params.shift;
+
+  // Audio doesn't use negativePrompt — strip it from the base keyFrame to avoid
+  // accidentally sending one if the user supplied an audio params object that
+  // happened to include the field via type widening.
+  delete keyFrame.negativePrompt;
+
+  return wrapJobRequest(id, keyFrame, params, {
+    previews: 0,
+    outputFormat: params.outputFormat || 'mp3'
+  });
+}
+
+function baseKeyFrame(
+  params: ImageProjectParams | VideoProjectParams | AudioProjectParams
+): Record<string, unknown> {
+  return {
+    ...buildBaseKeyFrame(),
+    modelID: params.modelId,
+    positivePrompt: params.positivePrompt,
+    steps: params.steps,
+    guidanceScale: params.guidance,
+    seed: params.seed,
+    ...('negativePrompt' in params && params.negativePrompt
+      ? { negativePrompt: params.negativePrompt }
+      : {}),
+    ...('stylePrompt' in params && params.stylePrompt ? { stylePrompt: params.stylePrompt } : {}),
+    ...('loras' in params && params.loras && params.loras.length ? { loras: params.loras } : {}),
+    ...('loraStrengths' in params && params.loraStrengths && params.loraStrengths.length
+      ? { loraStrengths: params.loraStrengths }
+      : {})
+  };
+}
+
+function wrapJobRequest(
+  id: string,
+  keyFrame: Record<string, unknown>,
+  params: ImageProjectParams | VideoProjectParams | AudioProjectParams,
+  extras: { previews: number; outputFormat: string }
+): Record<string, unknown> {
+  const jobRequest: Record<string, unknown> = {
+    ...buildTemplate(),
+    keyFrames: [keyFrame],
+    previews: extras.previews,
+    numberOfImages: params.numberOfMedia || 1,
+    jobID: id,
+    disableSafety:
+      'disableNSFWFilter' in params
+        ? !!(params as { disableNSFWFilter?: boolean }).disableNSFWFilter
+        : false,
+    outputFormat: extras.outputFormat
+  };
+  if (params.tokenType) jobRequest.tokenType = params.tokenType;
+  if (params.network) jobRequest.network = params.network;
+  if (params.appSource) jobRequest.appSource = params.appSource;
+  return jobRequest;
+}
+
+function buildBaseKeyFrame(): Record<string, unknown> {
+  return {
+    stepsIsEnabled: true,
+    siRotation: 0,
+    siDragOffsetIsEnabled: true,
+    strength: 0.5,
+    siZoomScaleIsEnabled: true,
+    isEnabled: true,
+    processing: 'CPU, GPU',
+    useLastImageAsGuideImageInAnimation: true,
+    guidanceScaleIsEnabled: true,
+    siImageBackgroundColor: 'black',
+    cnDragOffset: [0, 0],
+    scheduler: null,
+    timeStepSpacing: null,
+    steps: 20,
+    cnRotation: 0,
+    guidanceScale: 7.5,
+    siZoomScale: 1,
+    modelID: '',
+    cnRotationIsEnabled: true,
+    negativePrompt: '',
+    startingImageZoomPanIsOn: false,
+    seed: undefined,
+    siRotationIsEnabled: true,
+    cnImageBackgroundColor: 'clear',
+    strengthIsEnabled: true,
+    siDragOffset: [0, 0],
+    useLastImageAsCNImageInAnimation: false,
+    positivePrompt: '',
+    controlNetZoomPanIsOn: false,
+    cnZoomScaleIsEnabled: true,
+    currentControlNets: null,
+    stylePrompt: '',
+    cnDragOffsetIsEnabled: true,
+    frameIndex: 0,
+    startingImage: null,
+    cnZoomScale: 1
+  };
+}
+
+function buildTemplate(): Record<string, unknown> {
+  return {
+    selectedUpscalingModel: 'OFF',
+    cnVideoFramesSketch: [],
+    cnVideoFramesSegmentedSubject: [],
+    cnVideoFramesFace: [],
+    doCanvasBlending: false,
+    animationIsOn: false,
+    cnVideoFramesBoth: [],
+    cnVideoFramesDepth: [],
+    previews: 5,
+    frameRate: 24,
+    generatedVideoSeconds: 10,
+    canvasIsOn: false,
+    cnVideoFrames: [],
+    disableSafety: false,
+    cnVideoFramesSegmentedBackground: [],
+    cnVideoFramesSegmented: [],
+    numberOfImages: 1,
+    cnVideoFramesPose: [],
+    jobID: '',
+    siVideoFrames: []
+  };
+}