@decartai/sdk 0.0.20 → 0.0.22

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { ImageModels, Model, ModelDefinition, RealTimeModels, VideoModels, models } from "./shared/model.js";
+import { ImageModelDefinition, ImageModels, Model, ModelDefinition, RealTimeModels, VideoModelDefinition, VideoModels, models } from "./shared/model.js";
 import { FileInput, ProcessOptions } from "./process/types.js";
 import { ProcessClient } from "./process/client.js";
 import { JobStatus, JobStatusResponse, JobSubmitResponse, QueueJobResult, QueueSubmitAndPollOptions, QueueSubmitOptions } from "./queue/types.js";
@@ -10,30 +10,49 @@ import { z } from "zod";
 
 //#region src/index.d.ts
 declare const decartClientOptionsSchema: z.ZodObject<{
-  apiKey: z.ZodString;
+  apiKey: z.ZodOptional<z.ZodString>;
   baseUrl: z.ZodOptional<z.ZodURL>;
   integration: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
 type DecartClientOptions = z.infer<typeof decartClientOptionsSchema>;
-declare const createDecartClient: (options: DecartClientOptions) => {
+/**
+ * Create a Decart API client.
+ *
+ * @param options - Configuration options
+ * @param options.apiKey - API key for authentication. Defaults to the DECART_API_KEY environment variable.
+ * @param options.baseUrl - Override the default API base URL.
+ * @param options.integration - Optional integration identifier.
+ *
+ * @example
+ * ```ts
+ * // Option 1: Explicit API key
+ * const client = createDecartClient({ apiKey: "your-api-key" });
+ *
+ * // Option 2: Using DECART_API_KEY environment variable
+ * const client = createDecartClient();
+ * ```
+ */
+declare const createDecartClient: (options?: DecartClientOptions) => {
   realtime: {
     connect: (stream: MediaStream, options: RealTimeClientConnectOptions) => Promise<RealTimeClient>;
   };
   /**
-   * Client for video and image generation.
+   * Client for synchronous image generation.
+   * Only image models support the sync/process API.
    *
    * @example
    * ```ts
    * const client = createDecartClient({ apiKey: "your-api-key" });
    * const result = await client.process({
-   *   model: models.video("lucy-pro-t2v"),
+   *   model: models.image("lucy-pro-t2i"),
    *   prompt: "A beautiful sunset over the ocean"
    * });
    * ```
    */
   process: ProcessClient;
   /**
-   * Client for queue-based async video and image generation.
+   * Client for queue-based async video generation.
+   * Only video models support the queue API.
    * Jobs are submitted and processed asynchronously.
    *
    * @example
@@ -72,4 +91,4 @@ declare const createDecartClient: (options: DecartClientOptions) => {
   queue: QueueClient;
 };
 //#endregion
-export { DecartClientOptions, type DecartSDKError, ERROR_CODES, type FileInput, type ImageModels, type JobStatus, type JobStatusResponse, type JobSubmitResponse, type Model, type ModelDefinition, type ModelState, type ProcessClient, type ProcessOptions, type QueueClient, type QueueJobResult, type QueueSubmitAndPollOptions, type QueueSubmitOptions, type RealTimeClient, type RealTimeClientConnectOptions, type RealTimeClientInitialState, type RealTimeModels, type VideoModels, createDecartClient, models };
+export { DecartClientOptions, type DecartSDKError, ERROR_CODES, type FileInput, type ImageModelDefinition, type ImageModels, type JobStatus, type JobStatusResponse, type JobSubmitResponse, type Model, type ModelDefinition, type ModelState, type ProcessClient, type ProcessOptions, type QueueClient, type QueueJobResult, type QueueSubmitAndPollOptions, type QueueSubmitOptions, type RealTimeClient, type RealTimeClientConnectOptions, type RealTimeClientInitialState, type RealTimeModels, type VideoModelDefinition, type VideoModels, createDecartClient, models };

package/dist/index.js

@@ -3,23 +3,44 @@ import { createProcessClient } from "./process/client.js";
 import { createQueueClient } from "./queue/client.js";
 import { models } from "./shared/model.js";
 import { createRealTimeClient } from "./realtime/client.js";
+import { readEnv } from "./utils/env.js";
 import { z } from "zod";
 
 //#region src/index.ts
 const decartClientOptionsSchema = z.object({
-	apiKey: z.string().min(1),
+	apiKey: z.string().min(1).optional(),
 	baseUrl: z.url().optional(),
 	integration: z.string().optional()
 });
-const createDecartClient = (options) => {
-	const parsedOptions = decartClientOptionsSchema.safeParse(options);
+/**
+* Create a Decart API client.
+*
+* @param options - Configuration options
+* @param options.apiKey - API key for authentication. Defaults to the DECART_API_KEY environment variable.
+* @param options.baseUrl - Override the default API base URL.
+* @param options.integration - Optional integration identifier.
+*
+* @example
+* ```ts
+* // Option 1: Explicit API key
+* const client = createDecartClient({ apiKey: "your-api-key" });
+*
+* // Option 2: Using DECART_API_KEY environment variable
+* const client = createDecartClient();
+* ```
+*/
+const createDecartClient = (options = {}) => {
+	const apiKey = options.apiKey ?? readEnv("DECART_API_KEY");
+	if (!apiKey) throw createInvalidApiKeyError();
+	const parsedOptions = decartClientOptionsSchema.safeParse({
+		...options,
+		apiKey
+	});
 	if (!parsedOptions.success) {
-		const issue = parsedOptions.error.issues[0];
-		if (issue.path.includes("apiKey")) throw createInvalidApiKeyError();
-		if (issue.path.includes("baseUrl")) throw createInvalidBaseUrlError(options.baseUrl);
+		if (parsedOptions.error.issues[0].path.includes("baseUrl")) throw createInvalidBaseUrlError(options.baseUrl);
 		throw parsedOptions.error;
 	}
-	const { baseUrl = "https://api.decart.ai", apiKey, integration } = parsedOptions.data;
+	const { baseUrl = "https://api.decart.ai", integration } = parsedOptions.data;
 	const realtime = createRealTimeClient({
 		baseUrl: "wss://api3.decart.ai",
 		apiKey,

package/dist/process/client.d.ts

@@ -1,7 +1,12 @@
-import { ModelDefinition } from "../shared/model.js";
+import { ImageModelDefinition } from "../shared/model.js";
 import { ProcessOptions } from "./types.js";
 
 //#region src/process/client.d.ts
-type ProcessClient = <T extends ModelDefinition>(options: ProcessOptions<T>) => Promise<Blob>;
+
+/**
+ * Client for synchronous image generation.
+ * Only image models (t2i, i2i) support the sync/process API.
+ */
+type ProcessClient = <T extends ImageModelDefinition>(options: ProcessOptions<T>) => Promise<Blob>;
 //#endregion
 export { ProcessClient };

package/dist/process/types.d.ts

@@ -1,4 +1,4 @@
-import { ImageModels, ModelDefinition, ModelInputSchemas, VideoModels } from "../shared/model.js";
+import { ImageModelDefinition, ImageModels, ModelDefinition, ModelInputSchemas, VideoModels } from "../shared/model.js";
 import { z } from "zod";
 
 //#region src/process/types.d.ts
@@ -127,11 +127,12 @@ type PickDocumentedInputs<T extends ModelDefinition> = Pick<ModelSpecificProcess
  */
 type MergeDocumentedInputs<T extends ModelDefinition> = PickDocumentedInputs<T> & InferModelInputs<T>;
 /**
- * Options for the process client to generate video or image content.
+ * Options for the process client to generate image content.
+ * Only image models support the sync/process API.
  *
- * @template T - The model definition type
+ * @template T - The image model definition type
  */
-type ProcessOptions<T extends ModelDefinition = ModelDefinition> = {
+type ProcessOptions<T extends ImageModelDefinition = ImageModelDefinition> = {
   /**
    * The model definition to use.
    */

package/dist/queue/client.d.ts

@@ -1,7 +1,12 @@
-import { ModelDefinition } from "../shared/model.js";
+import { VideoModelDefinition } from "../shared/model.js";
 import { JobStatusResponse, JobSubmitResponse, QueueJobResult, QueueSubmitAndPollOptions, QueueSubmitOptions } from "./types.js";
 
 //#region src/queue/client.d.ts
+
+/**
+ * Client for queue-based async video generation.
+ * Only video models support the queue API.
+ */
 type QueueClient = {
   /**
    * Submit a job to the queue for async processing.
@@ -16,7 +21,7 @@ type QueueClient = {
    * console.log(job.job_id); // "job_abc123"
    * ```
    */
-  submit: <T extends ModelDefinition>(options: QueueSubmitOptions<T>) => Promise<JobSubmitResponse>;
+  submit: <T extends VideoModelDefinition>(options: QueueSubmitOptions<T>) => Promise<JobSubmitResponse>;
   /**
    * Get the current status of a job.
    *
@@ -59,7 +64,7 @@ type QueueClient = {
    * }
    * ```
    */
-  submitAndPoll: <T extends ModelDefinition>(options: QueueSubmitAndPollOptions<T>) => Promise<QueueJobResult>;
+  submitAndPoll: <T extends VideoModelDefinition>(options: QueueSubmitAndPollOptions<T>) => Promise<QueueJobResult>;
 };
 //#endregion
 export { QueueClient };

package/dist/queue/types.d.ts

@@ -1,4 +1,4 @@
-import { ModelDefinition } from "../shared/model.js";
+import { ModelDefinition, VideoModelDefinition } from "../shared/model.js";
 import { FileInput, InferModelInputs, ModelSpecificInputs, ProcessInputs } from "../process/types.js";
 
 //#region src/queue/types.d.ts
@@ -54,8 +54,9 @@ type PickDocumentedInputs<T extends ModelDefinition> = Pick<ModelSpecificQueueIn
 type MergeDocumentedInputs<T extends ModelDefinition> = PickDocumentedInputs<T> & InferModelInputs<T>;
 /**
  * Options for queue.submit() - submit a job for async processing.
+ * Only video models support the queue API.
  */
-type QueueSubmitOptions<T extends ModelDefinition = ModelDefinition> = {
+type QueueSubmitOptions<T extends VideoModelDefinition = VideoModelDefinition> = {
   /**
    * The model definition to use.
    */
@@ -67,8 +68,9 @@ type QueueSubmitOptions<T extends ModelDefinition = ModelDefinition> = {
 } & MergeDocumentedInputs<T>;
 /**
  * Options for queue.submitAndPoll() - submit and wait for completion.
+ * Only video models support the queue API.
  */
-type QueueSubmitAndPollOptions<T extends ModelDefinition = ModelDefinition> = QueueSubmitOptions<T> & {
+type QueueSubmitAndPollOptions<T extends VideoModelDefinition = VideoModelDefinition> = QueueSubmitOptions<T> & {
   /**
    * Callback invoked when job status changes during polling.
    * Receives the full job status response object.

package/dist/shared/model.d.ts

@@ -99,6 +99,16 @@ type ModelDefinition<T extends Model = Model> = {
   height: number;
   inputSchema: T extends keyof ModelInputSchemas ? ModelInputSchemas[T] : z.ZodTypeAny;
 };
+/**
+ * Type alias for model definitions that support synchronous processing.
+ * Only image models support the sync/process API.
+ */
+type ImageModelDefinition = ModelDefinition<ImageModels>;
+/**
+ * Type alias for model definitions that support queue processing.
+ * Only video models support the queue API.
+ */
+type VideoModelDefinition = ModelDefinition<VideoModels>;
 declare const models: {
   realtime: <T extends RealTimeModels>(model: T) => ModelDefinition<T>;
   /**
@@ -123,4 +133,4 @@ declare const models: {
   image: <T extends ImageModels>(model: T) => ModelDefinition<T>;
 };
 //#endregion
-export { ImageModels, Model, ModelDefinition, ModelInputSchemas, RealTimeModels, VideoModels, models };
+export { ImageModelDefinition, ImageModels, Model, ModelDefinition, ModelInputSchemas, RealTimeModels, VideoModelDefinition, VideoModels, models };

package/dist/utils/env.js

@@ -0,0 +1,9 @@
+//#region src/utils/env.ts
+const readEnv = (env) => {
+	const globalThisAny = globalThis;
+	if (typeof globalThisAny.process !== "undefined") return globalThisAny.process.env?.[env]?.trim();
+	if (typeof globalThisAny.Deno !== "undefined") return globalThisAny.Deno.env?.get?.(env)?.trim();
+};
+
+//#endregion
+export { readEnv };

package/dist/utils/errors.js

@@ -21,7 +21,7 @@ function createSDKError(code, message, data, cause) {
 	};
 }
 function createInvalidApiKeyError() {
-	return createSDKError(ERROR_CODES.INVALID_API_KEY, "API key is required and must be a non-empty string");
+	return createSDKError(ERROR_CODES.INVALID_API_KEY, "Missing API key. Pass `apiKey` to createDecartClient() or set the DECART_API_KEY environment variable.");
 }
 function createInvalidBaseUrlError(url) {
 	return createSDKError(ERROR_CODES.INVALID_BASE_URL, `Invalid base URL${url ? `: ${url}` : ""}`);

package/dist/version.js

@@ -4,7 +4,7 @@
 * Injected at build time from package.json.
 * Falls back to '0.0.0-dev' in development.
 */
-const VERSION = "0.0.20";
+const VERSION = "0.0.22";
 
 //#endregion
 export { VERSION };

package/package.json

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