@shop-os/modelkit 0.7.3 → 0.7.6

package/CHANGELOG.md

@@ -9,6 +9,20 @@ header in the release PR.
 
 ## [Unreleased]
 
+## [0.7.6] - Unreleased
+
+ENG-3323: one xAI reference-mode rule.
+
+### Changed
+- `xaiReferenceResolution` (kit-internal) now owns "is this request in xAI reference mode" and the 720p cap for both the resolver and the `xai-video` adapter. The adapter no longer keeps its own reference-mode check or its own copy of the refuse/lower rule. Requests, refusals and warnings are unchanged.
+
+## [0.7.4] - Unreleased
+
+ENG-3321: one source of truth for each 3D family's options.
+
+### Changed
+- The 3D family rules (`MODEL3D_FAMILY_RULES`, `model3dSpecIssues`) move from the catalog schema to `catalog/model3d-spec.ts`. Each family's texture and resolution options are now a map to the value the fal request sends (Hi3D `quality`/`master` to `2048quality`/`2048master`; Tripo `texture_quality`; Hunyuan `generate_type`; Meshy's text `mode`; Hi3D `enable_texture`). The catalog check allows only the map's keys and `model3dCall` sends its values, so an option cannot be offered without a value to send. An option missing from the map (only possible on an unvalidated `catalogOverride` row) now fails with `unsupported_option` instead of being sent as the family's default. Every request the current rows can make sends the same body as before.
+
 ## [0.7.3] - Unreleased
 
 ENG-3272 Luma code review follow-ups.

package/dist/catalog.cjs

@@ -6401,14 +6401,14 @@ function xaiReferenceMode(model, req) {
   const takesLastFrame = (model.constraints.supports ?? []).includes("lastFrame");
   return (req.referenceImages ?? []).length > 0 || takesLastFrame && req.lastFrame !== void 0;
 }
-function applyXaiVideoRules(model, req, onUnsupported, warnings) {
-  if (model.adapter !== "xai-video" || req.resolution !== "1080p") return;
-  if (!xaiReferenceMode(model, req)) return;
+function xaiReferenceResolution(model, req, onUnsupported, warnings, provider) {
+  if (req.resolution !== "1080p" || !xaiReferenceMode(model, req)) return void 0;
   const message = xaiReferenceResolutionMessage(model.id);
   if (onUnsupported === "error") {
     throw new ModelKitError({
       code: "unsupported_option",
       message,
+      ...provider === void 0 ? {} : { provider },
       model: model.id,
       retryable: false
     });
@@ -6420,7 +6420,12 @@ function applyXaiVideoRules(model, req, onUnsupported, warnings) {
     to: XAI_REFERENCE_MAX_RESOLUTION,
     message
   });
-  req.resolution = XAI_REFERENCE_MAX_RESOLUTION;
+  return XAI_REFERENCE_MAX_RESOLUTION;
+}
+function applyXaiVideoRules(model, req, onUnsupported, warnings) {
+  if (model.adapter !== "xai-video") return;
+  const lowered = xaiReferenceResolution(model, req, onUnsupported, warnings);
+  if (lowered !== void 0) req.resolution = lowered;
 }
 function takesTargetAspectRatio(model) {
   const ratios = model.constraints.aspectRatios ?? [];
@@ -6633,6 +6638,161 @@ var MODEL3D_IMAGE_SLOTS = {
   ordered: ["image", "left", "back", "right"],
   unordered: ["image", "back", "left", "right", "top"]
 };
+var MODEL3D_FAMILY_RULES = {
+  trellis: {
+    textPath: false,
+    views: ["none"],
+    multiImage: false,
+    texture: null,
+    pbr: false,
+    seed: true,
+    textureRef: false,
+    resolutions: "integer"
+  },
+  hunyuan: {
+    textPath: true,
+    views: ["none", "named"],
+    multiImage: false,
+    // generate_type
+    texture: { none: "Geometry", standard: "Normal" },
+    pbr: true,
+    seed: false,
+    textureRef: false,
+    resolutions: null
+  },
+  tripo: {
+    textPath: true,
+    views: ["none", "ordered"],
+    multiImage: true,
+    // texture_quality; null sends an untextured model.
+    texture: { none: null, standard: "standard", detailed: "detailed" },
+    pbr: true,
+    seed: true,
+    textureRef: false,
+    resolutions: null
+  },
+  rodin: {
+    textPath: true,
+    views: ["none", "unordered"],
+    multiImage: false,
+    texture: null,
+    pbr: false,
+    seed: true,
+    textureRef: false,
+    resolutions: null
+  },
+  meshy: {
+    textPath: true,
+    views: ["none", "unordered"],
+    multiImage: true,
+    // The text endpoint's mode; the image endpoints take should_texture.
+    texture: { none: "preview", standard: "full" },
+    pbr: true,
+    seed: true,
+    textureRef: true,
+    resolutions: null
+  },
+  hi3d: {
+    textPath: false,
+    views: ["none", "named"],
+    multiImage: true,
+    // enable_texture
+    texture: { none: false, standard: true },
+    pbr: true,
+    seed: false,
+    textureRef: false,
+    resolutions: { quality: "2048quality", master: "2048master" }
+  },
+  sam: {
+    textPath: false,
+    views: ["none"],
+    multiImage: false,
+    texture: null,
+    pbr: false,
+    seed: true,
+    textureRef: false,
+    resolutions: null
+  }
+};
+function model3dSpecIssues(spec) {
+  const issues = [];
+  const add = (path, message) => issues.push({ path, message });
+  const rules = MODEL3D_FAMILY_RULES[spec.family];
+  const promptOnly = spec.text && !spec.imageRequired;
+  if (spec.endpoints.image === void 0)
+    add(["endpoints", "image"], "every row needs an image endpoint");
+  if (promptOnly && !rules.textPath) {
+    add(
+      ["imageRequired"],
+      `${spec.family} has no text-to-3D endpoint; a text row needs an image`
+    );
+  }
+  if (promptOnly && spec.endpoints.text === void 0) {
+    add(["endpoints", "text"], "a text row needs a text endpoint");
+  }
+  if (!rules.views.includes(spec.views)) {
+    add(["views"], `${spec.family} takes views ${rules.views.join(" or ")}`);
+  }
+  if (spec.views === "none" && spec.maxImages !== 1) {
+    add(["maxImages"], "a row without views takes 1 image");
+  }
+  if (spec.views === "unordered" && spec.maxImages < 2) {
+    add(["maxImages"], "a row with views takes at least 2 images");
+  }
+  const slots = MODEL3D_IMAGE_SLOTS[spec.views].length;
+  if (spec.views !== "none" && spec.maxImages > slots) {
+    add(["maxImages"], `a row with ${spec.views} views sends at most ${slots} images`);
+  }
+  if ((spec.views === "named" || spec.views === "ordered") && spec.maxImages < slots) {
+    add(
+      ["maxImages"],
+      `a row with ${spec.views} views takes ${slots} images (front and three sides)`
+    );
+  }
+  if (spec.views !== "none" && rules.multiImage && spec.endpoints.multiImage === void 0) {
+    add(["endpoints", "multiImage"], `${spec.family} sends views to a multi-image endpoint`);
+  }
+  if (rules.texture === null) {
+    if (spec.texture.length > 0) add(["texture"], `${spec.family} has no texture switch`);
+  } else {
+    const allowed = rules.texture;
+    if (spec.texture.length === 0) add(["texture"], `${spec.family} needs its texture options`);
+    if (new Set(spec.texture).size !== spec.texture.length)
+      add(["texture"], "texture options repeat");
+    for (const t of spec.texture) {
+      if (!Object.hasOwn(allowed, t))
+        add(["texture"], `${spec.family} has no "${t}" texture`);
+    }
+  }
+  if (spec.pbr && !rules.pbr) add(["pbr"], `${spec.family} has no PBR switch`);
+  if (spec.pbr && !spec.texture.some((t) => t !== "none")) {
+    add(["pbr"], "PBR needs a textured option");
+  }
+  if (spec.seed && !rules.seed) add(["seed"], `${spec.family} takes no seed`);
+  if (spec.seedMax !== void 0 && !spec.seed) add(["seedMax"], "seedMax needs seed");
+  if (spec.textureRef && !rules.textureRef)
+    add(["textureRef"], `${spec.family} takes no texture reference`);
+  const res = spec.resolutions;
+  if (rules.resolutions === null) {
+    if (res !== void 0) add(["resolutions"], `${spec.family} has no resolution option`);
+  } else if (res === void 0) {
+    add(["resolutions"], `${spec.family} needs its resolution options`);
+  } else {
+    if (!res.options.includes(res.default)) {
+      add(["resolutions", "default"], "default must be an option");
+    }
+    if (new Set(res.options).size !== res.options.length) {
+      add(["resolutions", "options"], "resolution options repeat");
+    }
+    const allowed = rules.resolutions;
+    for (const option of res.options) {
+      const ok = allowed === "integer" ? /^[1-9][0-9]*$/.test(option) : Object.hasOwn(allowed, option);
+      if (!ok)
+        add(["resolutions", "options"], `${spec.family} has no "${option}" resolution`);
+    }
+  }
+  return issues;
+}
 function model3dInputRefusal(spec, wired) {
   const top = spec.views === "unordered" && wired.top === true;
   const anyView = spec.views !== "none" && (wired.back || wired.left || wired.right || top);
@@ -7214,156 +7374,6 @@ var LanguageOptionSchema = import_zod3.z.looseObject({
   code: import_zod3.z.string().min(1),
   name: import_zod3.z.string().min(1)
 });
-var MODEL3D_FAMILY_RULES = {
-  trellis: {
-    textPath: false,
-    views: ["none"],
-    multiImage: false,
-    texture: null,
-    pbr: false,
-    seed: true,
-    textureRef: false,
-    resolutions: "integer"
-  },
-  hunyuan: {
-    textPath: true,
-    views: ["none", "named"],
-    multiImage: false,
-    texture: ["none", "standard"],
-    pbr: true,
-    seed: false,
-    textureRef: false,
-    resolutions: null
-  },
-  tripo: {
-    textPath: true,
-    views: ["none", "ordered"],
-    multiImage: true,
-    texture: ["none", "standard", "detailed"],
-    pbr: true,
-    seed: true,
-    textureRef: false,
-    resolutions: null
-  },
-  rodin: {
-    textPath: true,
-    views: ["none", "unordered"],
-    multiImage: false,
-    texture: null,
-    pbr: false,
-    seed: true,
-    textureRef: false,
-    resolutions: null
-  },
-  meshy: {
-    textPath: true,
-    views: ["none", "unordered"],
-    multiImage: true,
-    texture: ["none", "standard"],
-    pbr: true,
-    seed: true,
-    textureRef: true,
-    resolutions: null
-  },
-  hi3d: {
-    textPath: false,
-    views: ["none", "named"],
-    multiImage: true,
-    texture: ["none", "standard"],
-    pbr: true,
-    seed: false,
-    textureRef: false,
-    resolutions: ["quality", "master"]
-  },
-  sam: {
-    textPath: false,
-    views: ["none"],
-    multiImage: false,
-    texture: null,
-    pbr: false,
-    seed: true,
-    textureRef: false,
-    resolutions: null
-  }
-};
-function model3dSpecIssues(spec) {
-  const issues = [];
-  const add = (path, message) => issues.push({ path, message });
-  const rules = MODEL3D_FAMILY_RULES[spec.family];
-  const promptOnly = spec.text && !spec.imageRequired;
-  if (spec.endpoints.image === void 0)
-    add(["endpoints", "image"], "every row needs an image endpoint");
-  if (promptOnly && !rules.textPath) {
-    add(
-      ["imageRequired"],
-      `${spec.family} has no text-to-3D endpoint; a text row needs an image`
-    );
-  }
-  if (promptOnly && spec.endpoints.text === void 0) {
-    add(["endpoints", "text"], "a text row needs a text endpoint");
-  }
-  if (!rules.views.includes(spec.views)) {
-    add(["views"], `${spec.family} takes views ${rules.views.join(" or ")}`);
-  }
-  if (spec.views === "none" && spec.maxImages !== 1) {
-    add(["maxImages"], "a row without views takes 1 image");
-  }
-  if (spec.views === "unordered" && spec.maxImages < 2) {
-    add(["maxImages"], "a row with views takes at least 2 images");
-  }
-  const slots = MODEL3D_IMAGE_SLOTS[spec.views].length;
-  if (spec.views !== "none" && spec.maxImages > slots) {
-    add(["maxImages"], `a row with ${spec.views} views sends at most ${slots} images`);
-  }
-  if ((spec.views === "named" || spec.views === "ordered") && spec.maxImages < slots) {
-    add(
-      ["maxImages"],
-      `a row with ${spec.views} views takes ${slots} images (front and three sides)`
-    );
-  }
-  if (spec.views !== "none" && rules.multiImage && spec.endpoints.multiImage === void 0) {
-    add(["endpoints", "multiImage"], `${spec.family} sends views to a multi-image endpoint`);
-  }
-  if (rules.texture === null) {
-    if (spec.texture.length > 0) add(["texture"], `${spec.family} has no texture switch`);
-  } else {
-    const allowed = rules.texture;
-    if (spec.texture.length === 0) add(["texture"], `${spec.family} needs its texture options`);
-    if (new Set(spec.texture).size !== spec.texture.length)
-      add(["texture"], "texture options repeat");
-    for (const t of spec.texture) {
-      if (!allowed.includes(t)) add(["texture"], `${spec.family} has no "${t}" texture`);
-    }
-  }
-  if (spec.pbr && !rules.pbr) add(["pbr"], `${spec.family} has no PBR switch`);
-  if (spec.pbr && !spec.texture.some((t) => t !== "none")) {
-    add(["pbr"], "PBR needs a textured option");
-  }
-  if (spec.seed && !rules.seed) add(["seed"], `${spec.family} takes no seed`);
-  if (spec.seedMax !== void 0 && !spec.seed) add(["seedMax"], "seedMax needs seed");
-  if (spec.textureRef && !rules.textureRef)
-    add(["textureRef"], `${spec.family} takes no texture reference`);
-  const res = spec.resolutions;
-  if (rules.resolutions === null) {
-    if (res !== void 0) add(["resolutions"], `${spec.family} has no resolution option`);
-  } else if (res === void 0) {
-    add(["resolutions"], `${spec.family} needs its resolution options`);
-  } else {
-    if (!res.options.includes(res.default)) {
-      add(["resolutions", "default"], "default must be an option");
-    }
-    if (new Set(res.options).size !== res.options.length) {
-      add(["resolutions", "options"], "resolution options repeat");
-    }
-    const allowed = rules.resolutions;
-    for (const option of res.options) {
-      const ok = allowed === "integer" ? /^[1-9][0-9]*$/.test(option) : allowed.includes(option);
-      if (!ok)
-        add(["resolutions", "options"], `${spec.family} has no "${option}" resolution`);
-    }
-  }
-  return issues;
-}
 var VideoToolConstraintsSchema = import_zod3.z.looseObject({
   kind: import_zod3.z.enum(["upscale", "interpolate", "hdr", "bg-remove", "subtitles"]),
   upscaleFactor: RangeSchema.optional(),