@decartai/sdk 0.0.6 → 0.0.11

package/dist/index.d.ts

@@ -10,6 +10,7 @@ import { z } from "zod";
 declare const decartClientOptionsSchema: z.ZodObject<{
   apiKey: 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) => {

package/dist/index.js

@@ -7,7 +7,8 @@ import { z } from "zod";
 //#region src/index.ts
 const decartClientOptionsSchema = z.object({
 	apiKey: z.string().min(1),
-	baseUrl: z.url().optional()
+	baseUrl: z.url().optional(),
+	integration: z.string().optional()
 });
 const createDecartClient = (options) => {
 	const parsedOptions = decartClientOptionsSchema.safeParse(options);
@@ -17,14 +18,16 @@ const createDecartClient = (options) => {
 		if (issue.path.includes("baseUrl")) throw createInvalidBaseUrlError(options.baseUrl);
 		throw parsedOptions.error;
 	}
-	const { baseUrl = "https://api.decart.ai", apiKey } = parsedOptions.data;
+	const { baseUrl = "https://api.decart.ai", apiKey, integration } = parsedOptions.data;
 	const realtime = createRealTimeClient({
 		baseUrl: "wss://api3.decart.ai",
-		apiKey
+		apiKey,
+		integration
 	});
 	const process = createProcessClient({
 		baseUrl,
-		apiKey
+		apiKey,
+		integration
 	});
 	return {
 		realtime,

package/dist/process/client.js

@@ -3,7 +3,7 @@ import { fileInputToBlob, sendRequest } from "./request.js";
 
 //#region src/process/client.ts
 const createProcessClient = (opts) => {
-	const { apiKey, baseUrl } = opts;
+	const { apiKey, baseUrl, integration } = opts;
 	const _process = async (options) => {
 		const { model, signal,...inputs } = options;
 		const parsedInputs = model.inputSchema.safeParse(inputs);
@@ -16,7 +16,8 @@ const createProcessClient = (opts) => {
 			apiKey,
 			model,
 			inputs: processedInputs,
-			signal
+			signal,
+			integration
 		});
 	};
 	return _process;

package/dist/process/request.js

@@ -1,4 +1,5 @@
 import { createInvalidInputError, createSDKError } from "../utils/errors.js";
+import { buildUserAgent } from "../utils/user-agent.js";
 
 //#region src/process/request.ts
 async function fileInputToBlob(input) {
@@ -13,14 +14,17 @@ async function fileInputToBlob(input) {
 	}
 	throw createInvalidInputError("Invalid file input type");
 }
-async function sendRequest({ baseUrl, apiKey, model, inputs, signal }) {
+async function sendRequest({ baseUrl, apiKey, model, inputs, signal, integration }) {
 	const formData = new FormData();
 	for (const [key, value] of Object.entries(inputs)) if (value !== void 0 && value !== null) if (value instanceof Blob) formData.append(key, value);
 	else formData.append(key, String(value));
 	const endpoint = `${baseUrl}${model.urlPath}`;
 	const response = await fetch(endpoint, {
 		method: "POST",
-		headers: { "X-API-KEY": apiKey },
+		headers: {
+			"X-API-KEY": apiKey,
+			"User-Agent": buildUserAgent(integration)
+		},
 		body: formData,
 		signal
 	});

package/dist/realtime/client.js

@@ -17,7 +17,7 @@ const realTimeClientConnectOptionsSchema = z.object({
 	customizeOffer: createAsyncFunctionSchema(z.function()).optional()
 });
 const createRealTimeClient = (opts) => {
-	const { baseUrl, apiKey } = opts;
+	const { baseUrl, apiKey, integration } = opts;
 	const connect = async (stream, options) => {
 		const eventEmitter = mitt();
 		const parsedOptions = realTimeClientConnectOptionsSchema.safeParse(options);
@@ -31,6 +31,7 @@ const createRealTimeClient = (opts) => {
 			sessionId,
 			fps: options.model.fps,
 			initialState,
+			integration,
 			onRemoteStream,
 			onConnectionStateChange: (state) => {
 				eventEmitter.emit("connectionChange", state);

package/dist/realtime/webrtc-connection.js

@@ -1,3 +1,5 @@
+import { buildUserAgent } from "../utils/user-agent.js";
+
 //#region src/realtime/webrtc-connection.ts
 const ICE_SERVERS = [{ urls: "stun:stun.l.google.com:19302" }];
 var WebRTCConnection = class {
@@ -9,13 +11,16 @@ var WebRTCConnection = class {
 	constructor(callbacks = {}) {
 		this.callbacks = callbacks;
 	}
-	async connect(url, localStream, timeout = 25e3) {
+	async connect(url, localStream, timeout = 25e3, integration) {
 		const deadline = Date.now() + timeout;
 		this.localStream = localStream;
+		const userAgent = encodeURIComponent(buildUserAgent(integration));
+		const separator = url.includes("?") ? "&" : "?";
+		const wsUrl = `${url}${separator}user_agent=${userAgent}`;
 		await new Promise((resolve, reject) => {
 			this.connectionReject = reject;
 			const timer = setTimeout(() => reject(/* @__PURE__ */ new Error("WebSocket timeout")), timeout);
-			this.ws = new WebSocket(url);
+			this.ws = new WebSocket(wsUrl);
 			this.ws.onopen = () => {
 				clearTimeout(timer);
 				resolve();

package/dist/realtime/webrtc-manager.js

@@ -24,7 +24,7 @@ var WebRTCManager = class {
 	}
 	async connect(localStream) {
 		return pRetry(async () => {
-			await this.connection.connect(this.config.webrtcUrl, localStream);
+			await this.connection.connect(this.config.webrtcUrl, localStream, 25e3, this.config.integration);
 			return true;
 		}, {
 			retries: 5,

package/dist/shared/model.js

@@ -104,7 +104,7 @@ const _models = {
 		mirage_v2: {
 			urlPath: "/v1/stream",
 			name: "mirage_v2",
-			fps: 12,
+			fps: 18,
 			width: 1280,
 			height: 704,
 			inputSchema: z.object({})

package/dist/utils/user-agent.js

@@ -0,0 +1,32 @@
+import { VERSION } from "../version.js";
+
+//#region src/utils/user-agent.ts
+function getRuntimeEnvironment(globalThisAny = globalThis) {
+	if (globalThisAny.window) return "runtime/browser";
+	if (globalThisAny.navigator?.userAgent) return `runtime/${globalThisAny.navigator.userAgent.toLowerCase()}`;
+	if (globalThisAny.process?.versions?.node) return `runtime/node.js/${globalThisAny.process.version.substring(0)}`;
+	if (globalThisAny.EdgeRuntime) return "runtime/vercel-edge";
+	return "runtime/unknown";
+}
+/**
+* Builds the User-Agent string for the SDK.
+* Format: decart-js-sdk/{version} lang/js {integration} {runtime}
+*
+* @param integration - Optional integration identifier (e.g., "vercel-ai-sdk/3.0.0")
+* @param globalThisAny - The global object (defaults to globalThis). Can be mocked for testing.
+* @returns Complete User-Agent string
+* @example
+* buildUserAgent() // => "decart-js-sdk/0.0.7 lang/js runtime/node.js/v18.17.0"
+* buildUserAgent("vercel-ai-sdk/3.0.0") // => "decart-js-sdk/0.0.7 lang/js vercel-ai-sdk/3.0.0 runtime/node.js/v18.17.0"
+*/
+function buildUserAgent(integration, globalThisAny = globalThis) {
+	return [
+		`decart-js-sdk/${VERSION}`,
+		"lang/js",
+		...integration ? [integration] : [],
+		getRuntimeEnvironment(globalThisAny)
+	].join(" ");
+}
+
+//#endregion
+export { buildUserAgent };

package/dist/version.js

@@ -0,0 +1,10 @@
+//#region src/version.ts
+/**
+* The current version of the Decart SDK.
+* Injected at build time from package.json.
+* Falls back to '0.0.0-dev' in development.
+*/
+const VERSION = "0.0.11";
+
+//#endregion
+export { VERSION };

package/package.json

@@ -1,61 +1,60 @@
 {
-	"name": "@decartai/sdk",
-	"version": "0.0.6",
-	"description": "Decart's JavaScript SDK",
-	"type": "module",
-	"license": "MIT",
-	"private": false,
-	"homepage": "https://github.com/decartai/sdk#readme",
-	"bugs": {
-		"url": "https://github.com/decartai/sdk/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/decartai/sdk.git"
-	},
-	"author": "Adir Amsalem <adir@decart.ai>",
-	"sideEffects": false,
-	"files": [
-		"dist"
-	],
-	"main": "./dist/index.js",
-	"module": "./dist/index.js",
-	"types": "./dist/index.d.ts",
-	"exports": {
-		".": "./dist/index.js",
-		"./package.json": "./package.json"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"scripts": {
-		"build": "tsdown",
-		"dev": "tsdown --watch",
-		"dev:example": "vite dev --port 3000",
-		"test": "vitest unit",
-		"test:e2e": "vitest e2e",
-		"typecheck": "tsc --noEmit",
-		"format": "biome format --write",
-		"format:check": "biome check",
-		"lint": "biome lint",
-		"prepublishOnly": "pnpm build",
-		"release": "bumpp && npm publish"
-	},
-	"devDependencies": {
-		"@types/node": "^22.15.17",
-		"biome": "^0.3.3",
-		"bumpp": "^10.1.0",
-		"msw": "^2.11.3",
-		"pkg-pr-new": "^0.0.56",
-		"tsdown": "^0.14.1",
-		"typescript": "^5.8.3",
-		"vite": "^7.1.2",
-		"vitest": "^3.1.3"
-	},
-	"dependencies": {
-		"mitt": "^3.0.1",
-		"p-retry": "^6.2.1",
-		"uuid": "^11.1.0",
-		"zod": "^4.0.17"
-	}
-}
+  "name": "@decartai/sdk",
+  "version": "0.0.11",
+  "description": "Decart's JavaScript SDK",
+  "type": "module",
+  "license": "MIT",
+  "private": false,
+  "homepage": "https://github.com/decartai/sdk#readme",
+  "bugs": {
+    "url": "https://github.com/decartai/sdk/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DecartAI/sdk"
+  },
+  "author": "Adir Amsalem <adir@decart.ai>",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.17",
+    "biome": "^0.3.3",
+    "bumpp": "^10.1.0",
+    "msw": "^2.11.3",
+    "pkg-pr-new": "^0.0.56",
+    "tsdown": "^0.14.1",
+    "typescript": "^5.8.3",
+    "vite": "^7.1.2",
+    "vitest": "^3.1.3"
+  },
+  "dependencies": {
+    "mitt": "^3.0.1",
+    "p-retry": "^6.2.1",
+    "uuid": "^11.1.0",
+    "zod": "^4.0.17"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "dev:example": "vite dev --port 3000",
+    "test": "vitest unit",
+    "test:e2e": "vitest e2e",
+    "typecheck": "tsc --noEmit",
+    "format": "biome format --write",
+    "format:check": "biome check",
+    "lint": "biome lint",
+    "release": "bumpp"
+  }
+}