Producer
- Streams your camera through lucy_2_rt and generates a subscribe link for viewers.
+ Streams your camera through lucy-2 and generates a subscribe link for viewers.
{status === "idle" && (
diff --git a/packages/proxy/README.md b/packages/proxy/README.md
index 2c999673..6c30f687 100644
--- a/packages/proxy/README.md
+++ b/packages/proxy/README.md
@@ -27,7 +27,7 @@ The proxy supports all model endpoints, apart from the realtime models.
## How It Works
-1. Client SDK makes a request to your proxy endpoint (e.g., `/api/decart/v1/generate/lucy-pro-i2i`)
+1. Client SDK makes a request to your proxy endpoint (e.g., `/api/decart/v1/generate/lucy-image-2`)
2. Proxy middleware intercepts the request
3. Proxy attaches your server's API key to the request
4. Proxy forwards the request to `https://api.decart.ai`
diff --git a/packages/proxy/src/express/README.md b/packages/proxy/src/express/README.md
index c720f98b..016ac415 100644
--- a/packages/proxy/src/express/README.md
+++ b/packages/proxy/src/express/README.md
@@ -25,7 +25,7 @@ const client = createDecartClient({ proxy: "/api/decart" });
// Use the client as normal
const result = await client.process({
- model: models.image("lucy-pro-i2i"),
+ model: models.image("lucy-image-2"),
prompt: "Make it look like a watercolor painting",
data: imageBlob,
});
diff --git a/packages/proxy/src/nextjs/README.md b/packages/proxy/src/nextjs/README.md
index f6f2275f..03cd1a84 100644
--- a/packages/proxy/src/nextjs/README.md
+++ b/packages/proxy/src/nextjs/README.md
@@ -35,7 +35,7 @@ const client = createDecartClient({ proxy: PROXY_ROUTE });
// Use the client as normal
const result = await client.process({
- model: models.image("lucy-pro-i2i"),
+ model: models.image("lucy-image-2"),
prompt: "Make it look like a watercolor painting",
data: imageBlob,
});
diff --git a/packages/sdk/src/process/types.ts b/packages/sdk/src/process/types.ts
index 3e83b35c..fef4f637 100644
--- a/packages/sdk/src/process/types.ts
+++ b/packages/sdk/src/process/types.ts
@@ -159,13 +159,13 @@ export interface PromptInput {
* This allows different models to have field-specific documentation while maintaining type safety.
* Specific models are checked first, then falls back to category-based selection.
*/
-export type ModelSpecificInputs
= T["name"] extends "lucy-pro-i2i"
+export type ModelSpecificInputs = T["name"] extends "lucy-pro-i2i" | "lucy-image-2"
? ImageEditingInputs
- : T["name"] extends "lucy-restyle-v2v"
+ : T["name"] extends "lucy-restyle-v2v" | "lucy-restyle-2"
? VideoRestyleInputs
- : T["name"] extends "lucy-2-v2v"
+ : T["name"] extends "lucy-2-v2v" | "lucy-2" | "lucy-2.1"
? VideoEdit2Inputs
- : T["name"] extends "lucy-pro-v2v"
+ : T["name"] extends "lucy-pro-v2v" | "lucy-clip"
? VideoEditInputs
: T["name"] extends ImageModels
? ImageGenerationInputs
diff --git a/packages/sdk/src/realtime/client.ts b/packages/sdk/src/realtime/client.ts
index f1869b0a..17d7f38b 100644
--- a/packages/sdk/src/realtime/client.ts
+++ b/packages/sdk/src/realtime/client.ts
@@ -135,7 +135,7 @@ export const createRealTimeClient = (opts: RealTimeClientOptions) => {
throw parsedOptions.error;
}
- const isAvatarLive = options.model.name === "live_avatar";
+ const isAvatarLive = options.model.name === "live_avatar" || options.model.name === "live-avatar";
const { onRemoteStream, initialState } = parsedOptions.data;
diff --git a/packages/sdk/src/realtime/webrtc-connection.ts b/packages/sdk/src/realtime/webrtc-connection.ts
index dc5802b9..17479adb 100644
--- a/packages/sdk/src/realtime/webrtc-connection.ts
+++ b/packages/sdk/src/realtime/webrtc-connection.ts
@@ -416,7 +416,7 @@ export class WebRTCConnection {
if (this.localStream) {
// For live_avatar: add receive-only video transceiver (sends audio only, receives audio+video)
- if (this.callbacks.modelName === "live_avatar") {
+ if (this.callbacks.modelName === "live_avatar" || this.callbacks.modelName === "live-avatar") {
this.pc.addTransceiver("video", { direction: "recvonly" });
}
diff --git a/packages/sdk/src/shared/model.ts b/packages/sdk/src/shared/model.ts
index d6cbc3b1..2f496da0 100644
--- a/packages/sdk/src/shared/model.ts
+++ b/packages/sdk/src/shared/model.ts
@@ -1,7 +1,49 @@
import { z } from "zod";
import { createModelNotFoundError } from "../utils/errors";
+/**
+ * Map of deprecated model names to their canonical replacements.
+ * Old names still work but will log a deprecation warning.
+ */
+const MODEL_ALIASES: Record = {
+ mirage: "lucy-restyle",
+ mirage_v2: "lucy-restyle-2",
+ lucy_v2v_720p_rt: "lucy",
+ lucy_2_rt: "lucy-2",
+ live_avatar: "live-avatar",
+ "lucy-pro-v2v": "lucy-clip",
+ "lucy-restyle-v2v": "lucy-restyle-2",
+ "lucy-2-v2v": "lucy-2",
+ "lucy-pro-i2i": "lucy-image-2",
+};
+
+const _warnedAliases = new Set();
+
+/** @internal Test-only helper to reset deprecation warning tracking */
+export function _resetDeprecationWarnings(): void {
+ _warnedAliases.clear();
+}
+
+function warnDeprecated(model: string): void {
+ const canonical = MODEL_ALIASES[model];
+ if (canonical && !_warnedAliases.has(model)) {
+ _warnedAliases.add(model);
+ console.warn(
+ `[Decart SDK] Model "${model}" is deprecated. Use "${canonical}" instead. See https://docs.platform.decart.ai/models for details.`,
+ );
+ }
+}
+
export const realtimeModels = z.union([
+ // Canonical names
+ z.literal("lucy"),
+ z.literal("lucy-2"),
+ z.literal("lucy-2.1"),
+ z.literal("lucy-2.1-vton"),
+ z.literal("lucy-restyle"),
+ z.literal("lucy-restyle-2"),
+ z.literal("live-avatar"),
+ // Deprecated names (use canonical names above instead)
z.literal("mirage"),
z.literal("mirage_v2"),
z.literal("lucy_v2v_720p_rt"),
@@ -9,12 +51,23 @@ export const realtimeModels = z.union([
z.literal("live_avatar"),
]);
export const videoModels = z.union([
- z.literal("lucy-pro-v2v"),
+ // Canonical names
+ z.literal("lucy-clip"),
+ z.literal("lucy-2"),
+ z.literal("lucy-2.1"),
+ z.literal("lucy-restyle-2"),
z.literal("lucy-motion"),
+ // Deprecated names (use canonical names above instead)
+ z.literal("lucy-pro-v2v"),
z.literal("lucy-restyle-v2v"),
z.literal("lucy-2-v2v"),
]);
-export const imageModels = z.literal("lucy-pro-i2i");
+export const imageModels = z.union([
+ // Canonical name
+ z.literal("lucy-image-2"),
+ // Deprecated name (use canonical name above instead)
+ z.literal("lucy-pro-i2i"),
+]);
export const modelSchema = z.union([realtimeModels, videoModels, imageModels]);
export type Model = z.infer;
@@ -67,41 +120,84 @@ const motionResolutionSchema = z
.describe("The resolution to use for the generation");
/**
- * Resolution schema for lucy-pro-v2v (supports 720p).
+ * Resolution schema for video-to-video models (supports 720p).
*/
-const proV2vResolutionSchema = z
+const v2vResolutionSchema = z
.literal("720p")
.optional()
.describe("The resolution to use for the generation")
.default("720p");
-export const modelInputSchemas = {
- "lucy-pro-v2v": z.object({
- prompt: z.string().min(1).max(1000).describe("The prompt to use for the generation"),
- data: fileInputSchema.describe(
- "The video data to use for generation (File, Blob, ReadableStream, URL, or string URL). Output video is limited to 5 seconds.",
+const videoEditSchema = z.object({
+ prompt: z.string().min(1).max(1000).describe("The prompt to use for the generation"),
+ data: fileInputSchema.describe(
+ "The video data to use for generation (File, Blob, ReadableStream, URL, or string URL). Output video is limited to 5 seconds.",
+ ),
+ reference_image: fileInputSchema
+ .optional()
+ .describe(
+ "Optional reference image to guide what to add to the video (File, Blob, ReadableStream, URL, or string URL)",
),
+ seed: z.number().optional().describe("The seed to use for the generation"),
+ resolution: v2vResolutionSchema,
+ enhance_prompt: z.boolean().optional().describe("Whether to enhance the prompt"),
+});
+
+const imageEditSchema = z.object({
+ prompt: z.string().min(1).max(1000).describe("The prompt to use for the generation"),
+ data: fileInputSchema.describe(
+ "The image data to use for generation (File, Blob, ReadableStream, URL, or string URL)",
+ ),
+ reference_image: fileInputSchema
+ .optional()
+ .describe("Optional reference image to guide the edit (File, Blob, ReadableStream, URL, or string URL)"),
+ seed: z.number().optional().describe("The seed to use for the generation"),
+ resolution: proResolutionSchema(),
+ enhance_prompt: z.boolean().optional().describe("Whether to enhance the prompt"),
+});
+
+const restyleSchema = z
+ .object({
+ prompt: z.string().min(1).max(1000).optional().describe("Text prompt for the video editing"),
reference_image: fileInputSchema
.optional()
- .describe(
- "Optional reference image to guide what to add to the video (File, Blob, ReadableStream, URL, or string URL)",
- ),
- seed: z.number().optional().describe("The seed to use for the generation"),
- resolution: proV2vResolutionSchema,
- enhance_prompt: z.boolean().optional().describe("Whether to enhance the prompt"),
- }),
- "lucy-pro-i2i": z.object({
- prompt: z.string().min(1).max(1000).describe("The prompt to use for the generation"),
- data: fileInputSchema.describe(
- "The image data to use for generation (File, Blob, ReadableStream, URL, or string URL)",
- ),
- reference_image: fileInputSchema
+ .describe("Reference image to transform into a prompt (File, Blob, ReadableStream, URL, or string URL)"),
+ data: fileInputSchema.describe("Video file to process (File, Blob, ReadableStream, URL, or string URL)"),
+ seed: z.number().optional().describe("Seed for the video generation"),
+ resolution: v2vResolutionSchema,
+ enhance_prompt: z
+ .boolean()
.optional()
- .describe("Optional reference image to guide the edit (File, Blob, ReadableStream, URL, or string URL)"),
- seed: z.number().optional().describe("The seed to use for the generation"),
- resolution: proResolutionSchema(),
- enhance_prompt: z.boolean().optional().describe("Whether to enhance the prompt"),
- }),
+ .describe("Whether to enhance the prompt (only valid with text prompt, defaults to true on backend)"),
+ })
+ .refine((data) => (data.prompt !== undefined) !== (data.reference_image !== undefined), {
+ message: "Must provide either 'prompt' or 'reference_image', but not both",
+ })
+ .refine((data) => !(data.reference_image !== undefined && data.enhance_prompt !== undefined), {
+ message: "'enhance_prompt' is only valid when using 'prompt', not 'reference_image'",
+ });
+
+const videoEdit2Schema = z.object({
+ prompt: z
+ .string()
+ .max(1000)
+ .describe("Text prompt for the video editing. Send an empty string if you want no text prompt."),
+ reference_image: fileInputSchema
+ .optional()
+ .describe("Optional reference image to guide the edit (File, Blob, ReadableStream, URL, or string URL)"),
+ data: fileInputSchema.describe("Video file to process (File, Blob, ReadableStream, URL, or string URL)"),
+ seed: z.number().optional().describe("The seed to use for the generation"),
+ resolution: v2vResolutionSchema,
+ enhance_prompt: z.boolean().optional().describe("Whether to enhance the prompt"),
+});
+
+export const modelInputSchemas = {
+ // Canonical names
+ "lucy-clip": videoEditSchema,
+ "lucy-image-2": imageEditSchema,
+ "lucy-restyle-2": restyleSchema,
+ "lucy-2": videoEdit2Schema,
+ "lucy-2.1": videoEdit2Schema,
"lucy-motion": z.object({
data: fileInputSchema.describe(
"The image data to use for generation (File, Blob, ReadableStream, URL, or string URL). Output video is limited to 5 seconds.",
@@ -120,39 +216,11 @@ export const modelInputSchemas = {
seed: z.number().optional().describe("The seed to use for the generation"),
resolution: motionResolutionSchema,
}),
- "lucy-restyle-v2v": z
- .object({
- prompt: z.string().min(1).max(1000).optional().describe("Text prompt for the video editing"),
- reference_image: fileInputSchema
- .optional()
- .describe("Reference image to transform into a prompt (File, Blob, ReadableStream, URL, or string URL)"),
- data: fileInputSchema.describe("Video file to process (File, Blob, ReadableStream, URL, or string URL)"),
- seed: z.number().optional().describe("Seed for the video generation"),
- resolution: proV2vResolutionSchema,
- enhance_prompt: z
- .boolean()
- .optional()
- .describe("Whether to enhance the prompt (only valid with text prompt, defaults to true on backend)"),
- })
- .refine((data) => (data.prompt !== undefined) !== (data.reference_image !== undefined), {
- message: "Must provide either 'prompt' or 'reference_image', but not both",
- })
- .refine((data) => !(data.reference_image !== undefined && data.enhance_prompt !== undefined), {
- message: "'enhance_prompt' is only valid when using 'prompt', not 'reference_image'",
- }),
- "lucy-2-v2v": z.object({
- prompt: z
- .string()
- .max(1000)
- .describe("Text prompt for the video editing. Send an empty string if you want no text prompt."),
- reference_image: fileInputSchema
- .optional()
- .describe("Optional reference image to guide the edit (File, Blob, ReadableStream, URL, or string URL)"),
- data: fileInputSchema.describe("Video file to process (File, Blob, ReadableStream, URL, or string URL)"),
- seed: z.number().optional().describe("The seed to use for the generation"),
- resolution: proV2vResolutionSchema,
- enhance_prompt: z.boolean().optional().describe("Whether to enhance the prompt"),
- }),
+ // Deprecated names (kept for backward compatibility)
+ "lucy-pro-v2v": videoEditSchema,
+ "lucy-pro-i2i": imageEditSchema,
+ "lucy-restyle-v2v": restyleSchema,
+ "lucy-2-v2v": videoEdit2Schema,
} as const;
export type ModelInputSchemas = typeof modelInputSchemas;
@@ -179,14 +247,16 @@ export type CustomModelDefinition = Omit;
+export type ImageModelDefinition = ModelDefinition & { queueUrlPath: string };
/**
* Type alias for model definitions that support queue processing.
* Only video models support the queue API.
+ * Requires `queueUrlPath` to distinguish from realtime definitions of the same model name.
*/
-export type VideoModelDefinition = ModelDefinition;
+export type VideoModelDefinition = ModelDefinition & { queueUrlPath: string };
export const modelDefinitionSchema = z.object({
name: z.string(),
@@ -200,6 +270,64 @@ export const modelDefinitionSchema = z.object({
const _models = {
realtime: {
+ // Canonical names
+ lucy: {
+ urlPath: "/v1/stream",
+ name: "lucy" as const,
+ fps: 25,
+ width: 1280,
+ height: 704,
+ inputSchema: z.object({}),
+ },
+ "lucy-2": {
+ urlPath: "/v1/stream",
+ name: "lucy-2" as const,
+ fps: 20,
+ width: 1280,
+ height: 720,
+ inputSchema: z.object({}),
+ },
+ "lucy-2.1": {
+ urlPath: "/v1/stream",
+ name: "lucy-2.1" as const,
+ fps: 20,
+ width: 1088,
+ height: 624,
+ inputSchema: z.object({}),
+ },
+ "lucy-2.1-vton": {
+ urlPath: "/v1/stream",
+ name: "lucy-2.1-vton" as const,
+ fps: 20,
+ width: 1088,
+ height: 624,
+ inputSchema: z.object({}),
+ },
+ "lucy-restyle": {
+ urlPath: "/v1/stream",
+ name: "lucy-restyle" as const,
+ fps: 25,
+ width: 1280,
+ height: 704,
+ inputSchema: z.object({}),
+ },
+ "lucy-restyle-2": {
+ urlPath: "/v1/stream",
+ name: "lucy-restyle-2" as const,
+ fps: 22,
+ width: 1280,
+ height: 704,
+ inputSchema: z.object({}),
+ },
+ "live-avatar": {
+ urlPath: "/v1/stream",
+ name: "live-avatar" as const,
+ fps: 25,
+ width: 1280,
+ height: 720,
+ inputSchema: z.object({}),
+ },
+ // Deprecated names (use canonical names above instead)
mirage: {
urlPath: "/v1/stream",
name: "mirage" as const,
@@ -242,6 +370,17 @@ const _models = {
},
},
image: {
+ // Canonical name
+ "lucy-image-2": {
+ urlPath: "/v1/generate/lucy-image-2",
+ queueUrlPath: "/v1/jobs/lucy-image-2",
+ name: "lucy-image-2" as const,
+ fps: 25,
+ width: 1280,
+ height: 704,
+ inputSchema: modelInputSchemas["lucy-image-2"],
+ },
+ // Deprecated name
"lucy-pro-i2i": {
urlPath: "/v1/generate/lucy-pro-i2i",
queueUrlPath: "/v1/jobs/lucy-pro-i2i",
@@ -253,14 +392,42 @@ const _models = {
},
},
video: {
- "lucy-pro-v2v": {
- urlPath: "/v1/generate/lucy-pro-v2v",
- queueUrlPath: "/v1/jobs/lucy-pro-v2v",
- name: "lucy-pro-v2v" as const,
+ // Canonical names
+ "lucy-clip": {
+ urlPath: "/v1/generate/lucy-clip",
+ queueUrlPath: "/v1/jobs/lucy-clip",
+ name: "lucy-clip" as const,
fps: 25,
width: 1280,
height: 704,
- inputSchema: modelInputSchemas["lucy-pro-v2v"],
+ inputSchema: modelInputSchemas["lucy-clip"],
+ },
+ "lucy-2": {
+ urlPath: "/v1/generate/lucy-2",
+ queueUrlPath: "/v1/jobs/lucy-2",
+ name: "lucy-2" as const,
+ fps: 20,
+ width: 1280,
+ height: 720,
+ inputSchema: modelInputSchemas["lucy-2"],
+ },
+ "lucy-2.1": {
+ urlPath: "/v1/generate/lucy-2.1",
+ queueUrlPath: "/v1/jobs/lucy-2.1",
+ name: "lucy-2.1" as const,
+ fps: 20,
+ width: 1088,
+ height: 624,
+ inputSchema: modelInputSchemas["lucy-2.1"],
+ },
+ "lucy-restyle-2": {
+ urlPath: "/v1/generate/lucy-restyle-2",
+ queueUrlPath: "/v1/jobs/lucy-restyle-2",
+ name: "lucy-restyle-2" as const,
+ fps: 22,
+ width: 1280,
+ height: 704,
+ inputSchema: modelInputSchemas["lucy-restyle-2"],
},
"lucy-motion": {
urlPath: "/v1/generate/lucy-motion",
@@ -271,6 +438,16 @@ const _models = {
height: 704,
inputSchema: modelInputSchemas["lucy-motion"],
},
+ // Deprecated names (use canonical names above instead)
+ "lucy-pro-v2v": {
+ urlPath: "/v1/generate/lucy-pro-v2v",
+ queueUrlPath: "/v1/jobs/lucy-pro-v2v",
+ name: "lucy-pro-v2v" as const,
+ fps: 25,
+ width: 1280,
+ height: 704,
+ inputSchema: modelInputSchemas["lucy-pro-v2v"],
+ },
"lucy-restyle-v2v": {
urlPath: "/v1/generate/lucy-restyle-v2v",
queueUrlPath: "/v1/jobs/lucy-restyle-v2v",
@@ -293,7 +470,20 @@ const _models = {
} as const;
export const models = {
+ /**
+ * Get a realtime streaming model identifier.
+ *
+ * Available options:
+ * - `"lucy-2"` - Lucy 2 realtime video editing (720p)
+ * - `"lucy-2.1"` - Lucy 2.1 realtime video editing
+ * - `"lucy-2.1-vton"` - Lucy 2.1 virtual try-on
+ * - `"lucy-restyle-2"` - Realtime video restyling
+ * - `"lucy-restyle"` - Legacy realtime restyling
+ * - `"lucy"` - Legacy Lucy realtime
+ * - `"live-avatar"` - Live avatar
+ */
realtime: (model: T): ModelDefinition => {
+ warnDeprecated(model);
const modelDefinition = _models.realtime[model];
if (!modelDefinition) {
throw createModelNotFoundError(model);
@@ -304,29 +494,32 @@ export const models = {
* Get a video model identifier.
*
* Available options:
- * - `"lucy-pro-v2v"` - Video-to-video
- * - `"lucy-restyle-v2v"` - Video-to-video (Restyling)
- * - `"lucy-2-v2v"` - Video-to-video (Long-form editing, 720p)
+ * - `"lucy-clip"` - Video-to-video editing
+ * - `"lucy-2"` - Long-form video editing (720p)
+ * - `"lucy-2.1"` - Long-form video editing (Lucy 2.1)
+ * - `"lucy-restyle-2"` - Video restyling
* - `"lucy-motion"` - Motion generation
*/
- video: (model: T): ModelDefinition => {
+ video: (model: T): ModelDefinition & { queueUrlPath: string } => {
+ warnDeprecated(model);
const modelDefinition = _models.video[model];
if (!modelDefinition) {
throw createModelNotFoundError(model);
}
- return modelDefinition as ModelDefinition;
+ return modelDefinition as ModelDefinition & { queueUrlPath: string };
},
/**
* Get an image model identifier.
*
* Available options:
- * - `"lucy-pro-i2i"` - Image-to-image
+ * - `"lucy-image-2"` - Image-to-image editing
*/
- image: (model: T): ModelDefinition => {
+ image: (model: T): ModelDefinition & { queueUrlPath: string } => {
+ warnDeprecated(model);
const modelDefinition = _models.image[model];
if (!modelDefinition) {
throw createModelNotFoundError(model);
}
- return modelDefinition as ModelDefinition;
+ return modelDefinition as ModelDefinition & { queueUrlPath: string };
},
};
diff --git a/packages/sdk/tests/e2e-realtime.test.ts b/packages/sdk/tests/e2e-realtime.test.ts
index 5b2651bd..d8464cd3 100644
--- a/packages/sdk/tests/e2e-realtime.test.ts
+++ b/packages/sdk/tests/e2e-realtime.test.ts
@@ -10,7 +10,20 @@ function createSyntheticStream(fps: number, width: number, height: number): Medi
return canvas.captureStream(fps);
}
-const REALTIME_MODELS: RealTimeModels[] = ["mirage", "mirage_v2", "lucy_v2v_720p_rt", "lucy_2_rt"];
+const REALTIME_MODELS: RealTimeModels[] = [
+ // Canonical names
+ "lucy-restyle",
+ "lucy-restyle-2",
+ "lucy",
+ "lucy-2",
+ "lucy-2.1",
+ "lucy-2.1-vton",
+ // Deprecated names
+ "mirage",
+ "mirage_v2",
+ "lucy_v2v_720p_rt",
+ "lucy_2_rt",
+];
const TIMEOUT = 1 * 60 * 1000; // 1 minute
describe.concurrent("Realtime E2E Tests", { timeout: TIMEOUT, retry: 2 }, () => {
diff --git a/packages/sdk/tests/e2e.test.ts b/packages/sdk/tests/e2e.test.ts
index e873d051..561d3b31 100644
--- a/packages/sdk/tests/e2e.test.ts
+++ b/packages/sdk/tests/e2e.test.ts
@@ -65,21 +65,21 @@ describe.concurrent("E2E Tests", { timeout: TIMEOUT, retry: 2 }, () => {
}
describe("Process API - Image Models", () => {
- it("lucy-pro-i2i: image-to-image", async () => {
+ it("lucy-image-2: image-to-image", async () => {
const result = await client.process({
- model: models.image("lucy-pro-i2i"),
+ model: models.image("lucy-image-2"),
prompt: "Oil painting in the style of Van Gogh",
data: imageBlob,
seed: 333,
enhance_prompt: false,
});
- await expectResult(result, "lucy-pro-i2i", ".png");
+ await expectResult(result, "lucy-image-2", ".png");
});
- it("lucy-pro-i2i: image-to-image with reference_image", async () => {
+ it("lucy-image-2: image-to-image with reference_image", async () => {
const result = await client.process({
- model: models.image("lucy-pro-i2i"),
+ model: models.image("lucy-image-2"),
prompt: "Add the object from the reference image",
data: imageBlob,
reference_image: imageBlob,
@@ -87,78 +87,150 @@ describe.concurrent("E2E Tests", { timeout: TIMEOUT, retry: 2 }, () => {
enhance_prompt: false,
});
- await expectResult(result, "lucy-pro-i2i-reference_image", ".png");
+ await expectResult(result, "lucy-image-2-reference_image", ".png");
+ });
+ });
+
+ describe("Process API - Image Models (deprecated names)", () => {
+ it("lucy-pro-i2i (deprecated): image-to-image", async () => {
+ const result = await client.process({
+ model: models.image("lucy-pro-i2i"),
+ prompt: "Oil painting in the style of Van Gogh",
+ data: imageBlob,
+ seed: 333,
+ enhance_prompt: false,
+ });
+
+ await expectResult(result, "lucy-pro-i2i", ".png");
});
});
describe("Queue API - Video Models", () => {
- it("lucy-pro-v2v: video-to-video", async () => {
+ it("lucy-clip: video-to-video", async () => {
const result = await client.queue.submitAndPoll({
- model: models.video("lucy-pro-v2v"),
+ model: models.video("lucy-clip"),
prompt: "Lego World animated style",
data: videoBlob,
seed: 999,
enhance_prompt: true,
});
- await expectResult(result, "lucy-pro-v2v", ".mp4");
+ await expectResult(result, "lucy-clip", ".mp4");
});
- it("lucy-restyle-v2v: video restyling (prompt)", async () => {
+ it("lucy-restyle-2: video restyling (prompt)", async () => {
const result = await client.queue.submitAndPoll({
- model: models.video("lucy-restyle-v2v"),
+ model: models.video("lucy-restyle-2"),
prompt: "Cyberpunk neon city style",
data: videoBlob,
seed: 777,
});
- await expectResult(result, "lucy-restyle-v2v-prompt", ".mp4");
+ await expectResult(result, "lucy-restyle-2-prompt", ".mp4");
});
- it("lucy-restyle-v2v: video restyling (reference_image)", async () => {
+ it("lucy-restyle-2: video restyling (reference_image)", async () => {
const result = await client.queue.submitAndPoll({
- model: models.video("lucy-restyle-v2v"),
+ model: models.video("lucy-restyle-2"),
reference_image: imageBlob,
data: videoBlob,
seed: 777,
});
- await expectResult(result, "lucy-restyle-v2v-reference_image", ".mp4");
+ await expectResult(result, "lucy-restyle-2-reference_image", ".mp4");
});
- it("lucy-2-v2v: video editing (prompt)", async () => {
+ it("lucy-2: video editing (prompt)", async () => {
const result = await client.queue.submitAndPoll({
- model: models.video("lucy-2-v2v"),
+ model: models.video("lucy-2"),
prompt: "Watercolor painting style with soft brushstrokes",
data: videoBlob,
seed: 42,
});
- await expectResult(result, "lucy-2-v2v-prompt", ".mp4");
+ await expectResult(result, "lucy-2-prompt", ".mp4");
});
- it("lucy-2-v2v: video editing (reference_image)", async () => {
+ it("lucy-2: video editing (reference_image)", async () => {
const result = await client.queue.submitAndPoll({
- model: models.video("lucy-2-v2v"),
+ model: models.video("lucy-2"),
prompt: "",
reference_image: imageBlob,
data: videoBlob,
seed: 42,
});
- await expectResult(result, "lucy-2-v2v-reference_image", ".mp4");
+ await expectResult(result, "lucy-2-reference_image", ".mp4");
});
- it("lucy-2-v2v: video editing (prompt + reference_image)", async () => {
+ it("lucy-2: video editing (prompt + reference_image)", async () => {
const result = await client.queue.submitAndPoll({
- model: models.video("lucy-2-v2v"),
+ model: models.video("lucy-2"),
prompt: "Watercolor painting style",
reference_image: imageBlob,
data: videoBlob,
seed: 42,
});
- await expectResult(result, "lucy-2-v2v-both", ".mp4");
+ await expectResult(result, "lucy-2-both", ".mp4");
+ });
+
+ it("lucy-2.1: video editing (prompt)", async () => {
+ const result = await client.queue.submitAndPoll({
+ model: models.video("lucy-2.1"),
+ prompt: "Watercolor painting style with soft brushstrokes",
+ data: videoBlob,
+ seed: 42,
+ });
+
+ await expectResult(result, "lucy-2.1-prompt", ".mp4");
+ });
+
+ it("lucy-2.1: video editing (reference_image)", async () => {
+ const result = await client.queue.submitAndPoll({
+ model: models.video("lucy-2.1"),
+ prompt: "",
+ reference_image: imageBlob,
+ data: videoBlob,
+ seed: 42,
+ });
+
+ await expectResult(result, "lucy-2.1-reference_image", ".mp4");
+ });
+
+ // Deprecated video model names (aliases)
+ it("lucy-pro-v2v (deprecated): video-to-video", async () => {
+ const result = await client.queue.submitAndPoll({
+ model: models.video("lucy-pro-v2v"),
+ prompt: "Lego World animated style",
+ data: videoBlob,
+ seed: 999,
+ enhance_prompt: true,
+ });
+
+ await expectResult(result, "lucy-pro-v2v", ".mp4");
+ });
+
+ it("lucy-restyle-v2v (deprecated): video restyling", async () => {
+ const result = await client.queue.submitAndPoll({
+ model: models.video("lucy-restyle-v2v"),
+ prompt: "Cyberpunk neon city style",
+ data: videoBlob,
+ seed: 777,
+ });
+
+ await expectResult(result, "lucy-restyle-v2v", ".mp4");
+ });
+
+ it("lucy-2-v2v (deprecated): video editing", async () => {
+ const result = await client.queue.submitAndPoll({
+ model: models.video("lucy-2-v2v"),
+ prompt: "Watercolor painting style with soft brushstrokes",
+ data: videoBlob,
+ seed: 42,
+ });
+
+ await expectResult(result, "lucy-2-v2v", ".mp4");
});
it("lucy-motion: motion-guided image-to-video", async () => {
diff --git a/packages/sdk/tests/unit.test.ts b/packages/sdk/tests/unit.test.ts
index fab9e622..339d9f09 100644
--- a/packages/sdk/tests/unit.test.ts
+++ b/packages/sdk/tests/unit.test.ts
@@ -1,7 +1,8 @@
import { HttpResponse, http } from "msw";
import { setupServer } from "msw/node";
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
-import { createDecartClient, models } from "../src/index.js";
+import { createDecartClient, isRealtimeModel, isVideoModel, models } from "../src/index.js";
+import { _resetDeprecationWarnings } from "../src/shared/model.js";
const MOCK_RESPONSE_DATA = new Uint8Array([0x00, 0x01, 0x02]).buffer;
const TEST_API_KEY = "test-api-key";
@@ -3402,3 +3403,173 @@ describe("CustomModelDefinition", () => {
expect(result.success).toBe(false);
});
});
+
+describe("Canonical Model Names", () => {
+ describe("Realtime canonical models", () => {
+ it("lucy canonical name works", () => {
+ const model = models.realtime("lucy");
+ expect(model.name).toBe("lucy");
+ expect(model.urlPath).toBe("/v1/stream");
+ expect(model.fps).toBe(25);
+ expect(model.width).toBe(1280);
+ expect(model.height).toBe(704);
+ });
+
+ it("lucy-2 canonical name works", () => {
+ const model = models.realtime("lucy-2");
+ expect(model.name).toBe("lucy-2");
+ expect(model.urlPath).toBe("/v1/stream");
+ expect(model.fps).toBe(20);
+ expect(model.width).toBe(1280);
+ expect(model.height).toBe(720);
+ });
+
+ it("lucy-2.1 canonical name works", () => {
+ const model = models.realtime("lucy-2.1");
+ expect(model.name).toBe("lucy-2.1");
+ expect(model.urlPath).toBe("/v1/stream");
+ expect(model.fps).toBe(20);
+ expect(model.width).toBe(1088);
+ expect(model.height).toBe(624);
+ });
+
+ it("lucy-2.1-vton canonical name works", () => {
+ const model = models.realtime("lucy-2.1-vton");
+ expect(model.name).toBe("lucy-2.1-vton");
+ expect(model.urlPath).toBe("/v1/stream");
+ expect(model.fps).toBe(20);
+ expect(model.width).toBe(1088);
+ expect(model.height).toBe(624);
+ });
+
+ it("lucy-restyle canonical name works", () => {
+ const model = models.realtime("lucy-restyle");
+ expect(model.name).toBe("lucy-restyle");
+ expect(model.fps).toBe(25);
+ });
+
+ it("lucy-restyle-2 canonical name works", () => {
+ const model = models.realtime("lucy-restyle-2");
+ expect(model.name).toBe("lucy-restyle-2");
+ expect(model.fps).toBe(22);
+ });
+
+ it("live-avatar canonical name works", () => {
+ const model = models.realtime("live-avatar");
+ expect(model.name).toBe("live-avatar");
+ expect(model.fps).toBe(25);
+ expect(model.width).toBe(1280);
+ expect(model.height).toBe(720);
+ });
+ });
+
+ describe("Video canonical models", () => {
+ it("lucy-clip canonical name works", () => {
+ const model = models.video("lucy-clip");
+ expect(model.name).toBe("lucy-clip");
+ expect(model.urlPath).toBe("/v1/generate/lucy-clip");
+ expect(model.queueUrlPath).toBe("/v1/jobs/lucy-clip");
+ expect(model.fps).toBe(25);
+ });
+
+ it("lucy-2 as video model works", () => {
+ const model = models.video("lucy-2");
+ expect(model.name).toBe("lucy-2");
+ expect(model.urlPath).toBe("/v1/generate/lucy-2");
+ expect(model.queueUrlPath).toBe("/v1/jobs/lucy-2");
+ expect(model.fps).toBe(20);
+ });
+
+ it("lucy-2.1 as video model works", () => {
+ const model = models.video("lucy-2.1");
+ expect(model.name).toBe("lucy-2.1");
+ expect(model.urlPath).toBe("/v1/generate/lucy-2.1");
+ expect(model.queueUrlPath).toBe("/v1/jobs/lucy-2.1");
+ });
+
+ it("lucy-restyle-2 as video model works", () => {
+ const model = models.video("lucy-restyle-2");
+ expect(model.name).toBe("lucy-restyle-2");
+ expect(model.urlPath).toBe("/v1/generate/lucy-restyle-2");
+ expect(model.queueUrlPath).toBe("/v1/jobs/lucy-restyle-2");
+ });
+ });
+
+ describe("Image canonical models", () => {
+ it("lucy-image-2 canonical name works", () => {
+ const model = models.image("lucy-image-2");
+ expect(model.name).toBe("lucy-image-2");
+ expect(model.urlPath).toBe("/v1/generate/lucy-image-2");
+ expect(model.queueUrlPath).toBe("/v1/jobs/lucy-image-2");
+ });
+ });
+
+ describe("Dual-surface models", () => {
+ it("lucy-2 is both a realtime and video model", () => {
+ expect(isRealtimeModel("lucy-2")).toBe(true);
+ expect(isVideoModel("lucy-2")).toBe(true);
+ });
+
+ it("lucy-2.1 is both a realtime and video model", () => {
+ expect(isRealtimeModel("lucy-2.1")).toBe(true);
+ expect(isVideoModel("lucy-2.1")).toBe(true);
+ });
+
+ it("lucy-restyle-2 is both a realtime and video model", () => {
+ expect(isRealtimeModel("lucy-restyle-2")).toBe(true);
+ expect(isVideoModel("lucy-restyle-2")).toBe(true);
+ });
+ });
+
+ describe("Deprecated names still work", () => {
+ it("lucy_2_rt still works as realtime model", () => {
+ const model = models.realtime("lucy_2_rt");
+ expect(model.name).toBe("lucy_2_rt");
+ });
+
+ it("mirage_v2 still works as realtime model", () => {
+ const model = models.realtime("mirage_v2");
+ expect(model.name).toBe("mirage_v2");
+ });
+
+ it("live_avatar still works as realtime model", () => {
+ const model = models.realtime("live_avatar");
+ expect(model.name).toBe("live_avatar");
+ });
+
+ it("lucy-pro-v2v still works as video model", () => {
+ const model = models.video("lucy-pro-v2v");
+ expect(model.name).toBe("lucy-pro-v2v");
+ });
+
+ it("lucy-pro-i2i still works as image model", () => {
+ const model = models.image("lucy-pro-i2i");
+ expect(model.name).toBe("lucy-pro-i2i");
+ });
+ });
+
+ describe("Deprecation warnings", () => {
+ it("warns when using deprecated model name", () => {
+ _resetDeprecationWarnings();
+ const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+
+ models.video("lucy-pro-v2v");
+ expect(warnSpy).toHaveBeenCalledWith(
+ expect.stringContaining('Model "lucy-pro-v2v" is deprecated. Use "lucy-clip" instead.'),
+ );
+
+ warnSpy.mockRestore();
+ });
+
+ it("warns only once per deprecated alias", () => {
+ _resetDeprecationWarnings();
+ const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+
+ models.video("lucy-pro-v2v");
+ models.video("lucy-pro-v2v");
+ expect(warnSpy).toHaveBeenCalledTimes(1);
+
+ warnSpy.mockRestore();
+ });
+ });
+});