@decartai/sdk 0.0.65 → 0.0.66

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { LogLevel, Logger, createConsoleLogger, noopLogger } from "./utils/logger.js";
-import { CustomModelDefinition, ImageModelDefinition, ImageModels, Model, ModelDefinition, RealTimeModels, VideoModelDefinition, VideoModels, isImageModel, isRealtimeModel, isVideoModel, models } from "./shared/model.js";
+import { CanonicalModel, CustomModelDefinition, ImageModelDefinition, ImageModels, ListedModelDefinition, Model, ModelDefinition, ModelKind, RealTimeModels, VideoModelDefinition, VideoModels, isCanonicalModel, isImageModel, isModel, isRealtimeModel, isVideoModel, listModels, modelAliases, models, resolveCanonicalModelAlias, resolveModelAlias } from "./shared/model.js";
 import { FileInput, ProcessOptions, ReactNativeFile } from "./process/types.js";
 import { ProcessClient } from "./process/client.js";
 import { JobStatus, JobStatusResponse, JobSubmitResponse, QueueJobResult, QueueSubmitAndPollOptions, QueueSubmitOptions } from "./queue/types.js";
@@ -134,4 +134,4 @@ declare const createDecartClient: (options?: DecartClientOptions) => {
   tokens: TokensClient;
 };
 //#endregion
-export { type ConnectionPhase, type ConnectionState, type CreateTokenOptions, type CreateTokenResponse, type CustomModelDefinition, DecartClientOptions, type DecartSDKError, type DiagnosticEvent, type DiagnosticEventName, type DiagnosticEvents, ERROR_CODES, type FileInput, type IceCandidateEvent, type IceStateEvent, type ImageModelDefinition, type ImageModels, type JobStatus, type JobStatusResponse, type JobSubmitResponse, type LogLevel, type Logger, type Model, type ModelDefinition, type ModelState, type PeerConnectionStateEvent, type PhaseTimingEvent, type ProcessClient, type ProcessOptions, type QueueClient, type QueueJobResult, type QueueSubmitAndPollOptions, type QueueSubmitOptions, type ReactNativeFile, type RealTimeClient, type RealTimeClientConnectOptions, type RealTimeClientInitialState, type Events as RealTimeEvents, type RealTimeModels, type RealTimeSubscribeClient, type ReconnectEvent, type SelectedCandidatePairEvent, type SetInput, type SignalingStateEvent, type SubscribeEvents, type SubscribeOptions, type TokensClient, type VideoModelDefinition, type VideoModels, type VideoStallEvent, type WebRTCStats, createConsoleLogger, createDecartClient, isImageModel, isRealtimeModel, isVideoModel, models, noopLogger };
+export { type CanonicalModel, type ConnectionPhase, type ConnectionState, type CreateTokenOptions, type CreateTokenResponse, type CustomModelDefinition, DecartClientOptions, type DecartSDKError, type DiagnosticEvent, type DiagnosticEventName, type DiagnosticEvents, ERROR_CODES, type FileInput, type IceCandidateEvent, type IceStateEvent, type ImageModelDefinition, type ImageModels, type JobStatus, type JobStatusResponse, type JobSubmitResponse, type ListedModelDefinition, type LogLevel, type Logger, type Model, type ModelDefinition, type ModelKind, type ModelState, type PeerConnectionStateEvent, type PhaseTimingEvent, type ProcessClient, type ProcessOptions, type QueueClient, type QueueJobResult, type QueueSubmitAndPollOptions, type QueueSubmitOptions, type ReactNativeFile, type RealTimeClient, type RealTimeClientConnectOptions, type RealTimeClientInitialState, type Events as RealTimeEvents, type RealTimeModels, type RealTimeSubscribeClient, type ReconnectEvent, type SelectedCandidatePairEvent, type SetInput, type SignalingStateEvent, type SubscribeEvents, type SubscribeOptions, type TokensClient, type VideoModelDefinition, type VideoModels, type VideoStallEvent, type WebRTCStats, createConsoleLogger, createDecartClient, isCanonicalModel, isImageModel, isModel, isRealtimeModel, isVideoModel, listModels, modelAliases, models, noopLogger, resolveCanonicalModelAlias, resolveModelAlias };

package/dist/index.js

@@ -1,7 +1,7 @@
 import { ERROR_CODES, createInvalidApiKeyError, createInvalidBaseUrlError } from "./utils/errors.js";
 import { createProcessClient } from "./process/client.js";
 import { createQueueClient } from "./queue/client.js";
-import { isImageModel, isRealtimeModel, isVideoModel, models } from "./shared/model.js";
+import { isCanonicalModel, isImageModel, isModel, isRealtimeModel, isVideoModel, listModels, modelAliases, models, resolveCanonicalModelAlias, resolveModelAlias } from "./shared/model.js";
 import { createRealTimeClient } from "./realtime/client.js";
 import { createTokensClient } from "./tokens/client.js";
 import { readEnv } from "./utils/env.js";
@@ -88,4 +88,4 @@ const createDecartClient = (options = {}) => {
 };
 
 //#endregion
-export { ERROR_CODES, createConsoleLogger, createDecartClient, isImageModel, isRealtimeModel, isVideoModel, models, noopLogger };
+export { ERROR_CODES, createConsoleLogger, createDecartClient, isCanonicalModel, isImageModel, isModel, isRealtimeModel, isVideoModel, listModels, modelAliases, models, noopLogger, resolveCanonicalModelAlias, resolveModelAlias };

package/dist/shared/model.d.ts

@@ -1,6 +1,30 @@
 import { z } from "zod";
 
 //#region src/shared/model.d.ts
+
+declare const canonicalModelSchema: z.ZodEnum<{
+  "lucy-2.1": "lucy-2.1";
+  "lucy-2.1-vton": "lucy-2.1-vton";
+  "lucy-vton-2": "lucy-vton-2";
+  "lucy-restyle-2": "lucy-restyle-2";
+  "lucy-clip": "lucy-clip";
+  "lucy-image-2": "lucy-image-2";
+}>;
+type CanonicalModel = z.infer<typeof canonicalModelSchema>;
+/**
+ * Map of deprecated model names to their canonical replacements.
+ * Old names still work but will log a deprecation warning.
+ */
+declare const modelAliases: {
+  readonly mirage_v2: "lucy-restyle-2";
+  readonly "lucy-vton": "lucy-2.1-vton";
+  readonly "lucy-2.1-vton-2": "lucy-vton-2";
+  readonly "lucy-pro-v2v": "lucy-clip";
+  readonly "lucy-restyle-v2v": "lucy-restyle-2";
+  readonly "lucy-pro-i2i": "lucy-image-2";
+};
+/** @internal Test-only helper to reset deprecation warning tracking */
+
 declare const realtimeModels: z.ZodUnion<readonly [z.ZodLiteral<"lucy-2.1">, z.ZodLiteral<"lucy-2.1-vton">, z.ZodLiteral<"lucy-vton-2">, z.ZodLiteral<"lucy-restyle-2">, z.ZodLiteral<"lucy-latest">, z.ZodLiteral<"lucy-vton-latest">, z.ZodLiteral<"lucy-restyle-latest">, z.ZodLiteral<"mirage_v2">, z.ZodLiteral<"lucy-vton">, z.ZodLiteral<"lucy-2.1-vton-2">]>;
 declare const videoModels: z.ZodUnion<readonly [z.ZodLiteral<"lucy-clip">, z.ZodLiteral<"lucy-2.1">, z.ZodLiteral<"lucy-2.1-vton">, z.ZodLiteral<"lucy-vton-2">, z.ZodLiteral<"lucy-restyle-2">, z.ZodLiteral<"lucy-latest">, z.ZodLiteral<"lucy-vton-latest">, z.ZodLiteral<"lucy-restyle-latest">, z.ZodLiteral<"lucy-clip-latest">, z.ZodLiteral<"lucy-vton">, z.ZodLiteral<"lucy-2.1-vton-2">, z.ZodLiteral<"lucy-pro-v2v">, z.ZodLiteral<"lucy-restyle-v2v">]>;
 declare const imageModels: z.ZodUnion<readonly [z.ZodLiteral<"lucy-image-2">, z.ZodLiteral<"lucy-image-latest">, z.ZodLiteral<"lucy-pro-i2i">]>;
@@ -12,6 +36,20 @@ type ImageModels = z.infer<typeof imageModels>;
 declare function isRealtimeModel(model: string): model is RealTimeModels;
 declare function isVideoModel(model: string): model is VideoModels;
 declare function isImageModel(model: string): model is ImageModels;
+declare function isModel(model: string): model is Model;
+declare function isCanonicalModel(model: string): model is CanonicalModel;
+/**
+ * Resolve deprecated aliases to canonical model names and pass accepted model names through unchanged.
+ * Latest aliases pass through unchanged because they are server-side moving targets. This is a pure normalization helper
+ * and does not emit deprecation warnings.
+ */
+declare function resolveModelAlias(model: string): Model | undefined;
+/**
+ * Resolve deprecated aliases and canonical inputs to stable canonical model names.
+ * Latest aliases are server-side moving targets, so they intentionally return undefined. This is a pure normalization
+ * helper and does not emit deprecation warnings.
+ */
+declare function resolveCanonicalModelAlias(model: string): CanonicalModel | undefined;
 declare const modelInputSchemas: {
   readonly "lucy-clip": z.ZodObject<{
     prompt: z.ZodString;
@@ -313,6 +351,19 @@ type ImageModelDefinition = ModelDefinition<ImageModels> & {
 type VideoModelDefinition = ModelDefinition<VideoModels> & {
   queueUrlPath: string;
 };
+type ModelKind = "realtime" | "video" | "image";
+type ListedModelDefinition = ModelDefinition & {
+  kind: ModelKind;
+};
+/**
+ * List SDK model definitions by kind.
+ * When canonicalOnly is true, deprecated and latest aliases are excluded per kind. Models available in multiple kinds
+ * are returned once per kind with the same name and different kind values.
+ */
+declare function listModels(options?: {
+  kind?: ModelKind;
+  canonicalOnly?: boolean;
+}): ListedModelDefinition[];
 declare const models: {
   /**
    * Get a realtime streaming model identifier.
@@ -348,4 +399,4 @@ declare const models: {
   };
 };
 //#endregion
-export { CustomModelDefinition, ImageModelDefinition, ImageModels, Model, ModelDefinition, ModelInputSchemas, RealTimeModels, VideoModelDefinition, VideoModels, isImageModel, isRealtimeModel, isVideoModel, models };
+export { CanonicalModel, CustomModelDefinition, ImageModelDefinition, ImageModels, ListedModelDefinition, Model, ModelDefinition, ModelInputSchemas, ModelKind, RealTimeModels, VideoModelDefinition, VideoModels, isCanonicalModel, isImageModel, isModel, isRealtimeModel, isVideoModel, listModels, modelAliases, models, resolveCanonicalModelAlias, resolveModelAlias };

package/dist/shared/model.js

@@ -2,11 +2,37 @@ import { createModelNotFoundError } from "../utils/errors.js";
 import { z } from "zod";
 
 //#region src/shared/model.ts
+const CANONICAL_MODEL_NAMES = [
+	"lucy-2.1",
+	"lucy-2.1-vton",
+	"lucy-vton-2",
+	"lucy-restyle-2",
+	"lucy-clip",
+	"lucy-image-2"
+];
+const CANONICAL_REALTIME_MODEL_NAMES = [
+	"lucy-2.1",
+	"lucy-2.1-vton",
+	"lucy-vton-2",
+	"lucy-restyle-2"
+];
+const CANONICAL_VIDEO_MODEL_NAMES = [
+	"lucy-clip",
+	"lucy-2.1",
+	"lucy-2.1-vton",
+	"lucy-vton-2",
+	"lucy-restyle-2"
+];
+const CANONICAL_IMAGE_MODEL_NAMES = ["lucy-image-2"];
+const canonicalRealtimeModels = z.enum(CANONICAL_REALTIME_MODEL_NAMES);
+const canonicalVideoModels = z.enum(CANONICAL_VIDEO_MODEL_NAMES);
+const canonicalImageModels = z.enum(CANONICAL_IMAGE_MODEL_NAMES);
+const canonicalModelSchema = z.enum(CANONICAL_MODEL_NAMES);
 /**
 * Map of deprecated model names to their canonical replacements.
 * Old names still work but will log a deprecation warning.
 */
-const MODEL_ALIASES = {
+const modelAliases = {
 	mirage_v2: "lucy-restyle-2",
 	"lucy-vton": "lucy-2.1-vton",
 	"lucy-2.1-vton-2": "lucy-vton-2",
@@ -16,7 +42,7 @@ const MODEL_ALIASES = {
 };
 const _warnedAliases = /* @__PURE__ */ new Set();
 function warnDeprecated(model) {
-	const canonical = MODEL_ALIASES[model];
+	const canonical = modelAliases[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.`);
@@ -68,6 +94,34 @@ function isVideoModel(model) {
 function isImageModel(model) {
 	return imageModels.safeParse(model).success;
 }
+function isModel(model) {
+	return modelSchema.safeParse(model).success;
+}
+function isCanonicalModel(model) {
+	return canonicalModelSchema.safeParse(model).success;
+}
+/**
+* Resolve deprecated aliases to canonical model names and pass accepted model names through unchanged.
+* Latest aliases pass through unchanged because they are server-side moving targets. This is a pure normalization helper
+* and does not emit deprecation warnings.
+*/
+function resolveModelAlias(model) {
+	const canonical = modelAliases[model];
+	if (canonical) return canonical;
+	const parsedModel = modelSchema.safeParse(model);
+	return parsedModel.success ? parsedModel.data : void 0;
+}
+/**
+* Resolve deprecated aliases and canonical inputs to stable canonical model names.
+* Latest aliases are server-side moving targets, so they intentionally return undefined. This is a pure normalization
+* helper and does not emit deprecation warnings.
+*/
+function resolveCanonicalModelAlias(model) {
+	const canonical = modelAliases[model];
+	if (canonical) return canonical;
+	const parsedModel = canonicalModelSchema.safeParse(model);
+	return parsedModel.success ? parsedModel.data : void 0;
+}
 const fileInputSchema = z.union([
 	z.instanceof(File),
 	z.instanceof(Blob),
@@ -382,6 +436,29 @@ const _models = {
 		}
 	}
 };
+const modelKinds = [
+	"realtime",
+	"video",
+	"image"
+];
+const canonicalSchemasByKind = {
+	realtime: canonicalRealtimeModels,
+	video: canonicalVideoModels,
+	image: canonicalImageModels
+};
+/**
+* List SDK model definitions by kind.
+* When canonicalOnly is true, deprecated and latest aliases are excluded per kind. Models available in multiple kinds
+* are returned once per kind with the same name and different kind values.
+*/
+function listModels(options = {}) {
+	return (options.kind ? [options.kind] : modelKinds).flatMap((kind) => {
+		return Object.values(_models[kind]).filter((modelDefinition) => !options.canonicalOnly || canonicalSchemasByKind[kind].safeParse(modelDefinition.name).success).map((modelDefinition) => ({
+			...modelDefinition,
+			kind
+		}));
+	});
+}
 const models = {
 	realtime: (model) => {
 		warnDeprecated(model);
@@ -404,4 +481,4 @@ const models = {
 };
 
 //#endregion
-export { isImageModel, isRealtimeModel, isVideoModel, modelDefinitionSchema, models };
+export { isCanonicalModel, isImageModel, isModel, isRealtimeModel, isVideoModel, listModels, modelAliases, modelDefinitionSchema, models, resolveCanonicalModelAlias, resolveModelAlias };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@decartai/sdk",
-  "version": "0.0.65",
+  "version": "0.0.66",
   "description": "Decart's JavaScript SDK",
   "type": "module",
   "license": "MIT",