@copilotkit/shared 1.55.0-next.9 → 1.55.0

package/dist/index.umd.js

@@ -911,7 +911,7 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 
 //#endregion
 //#region package.json
-	var version = "1.55.0-next.9";
+	var version = "1.55.0";
 
 //#endregion
 //#region src/telemetry/scarf-client.ts
@@ -1042,6 +1042,135 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 		throw new Error(`Cannot convert schema to JSON Schema. The schema (vendor: "${vendor}") does not implement Standard JSON Schema V1 and no zodToJsonSchema fallback is available. Use a library that supports Standard JSON Schema (e.g., Zod 3.24+, Valibot v1+, ArkType v2+) or pass a zodToJsonSchema function in options.`);
 	}
 
+//#endregion
+//#region src/attachments/utils.ts
+	const DEFAULT_MAX_SIZE = 20 * 1024 * 1024;
+	/**
+	* Derive the attachment modality from a MIME type string.
+	*/
+	function getModalityFromMimeType(mimeType) {
+		if (mimeType.startsWith("image/")) return "image";
+		if (mimeType.startsWith("audio/")) return "audio";
+		if (mimeType.startsWith("video/")) return "video";
+		return "document";
+	}
+	/**
+	* Format a byte count as a human-readable file size string.
+	*/
+	function formatFileSize(bytes) {
+		if (bytes < 1024) return `${bytes} B`;
+		if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
+		return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
+	}
+	/**
+	* Check if a file exceeds the maximum allowed size.
+	*/
+	function exceedsMaxSize(file, maxSize = DEFAULT_MAX_SIZE) {
+		return file.size > maxSize;
+	}
+	/**
+	* Read a File as a base64 string (without the data URL prefix).
+	*/
+	function readFileAsBase64(file) {
+		return new Promise((resolve, reject) => {
+			const reader = new FileReader();
+			reader.onload = (e) => {
+				var _e$target;
+				const result = (_e$target = e.target) === null || _e$target === void 0 ? void 0 : _e$target.result;
+				const base64 = result === null || result === void 0 ? void 0 : result.split(",")[1];
+				if (base64) resolve(base64);
+				else reject(/* @__PURE__ */ new Error("Failed to read file as base64"));
+			};
+			reader.onerror = reject;
+			reader.readAsDataURL(file);
+		});
+	}
+	/**
+	* Generate a thumbnail data URL from a video file by capturing a frame near the start (at 0.1s).
+	* Returns undefined if thumbnail generation fails or if called outside a browser environment.
+	*/
+	function generateVideoThumbnail(file) {
+		if (typeof document === "undefined") return Promise.resolve(void 0);
+		return new Promise((resolve) => {
+			let resolved = false;
+			const video = document.createElement("video");
+			const canvas = document.createElement("canvas");
+			const url = URL.createObjectURL(file);
+			const cleanup = (result) => {
+				if (resolved) return;
+				resolved = true;
+				URL.revokeObjectURL(url);
+				resolve(result);
+			};
+			const timeout = setTimeout(() => {
+				console.warn(`[CopilotKit] generateVideoThumbnail: timed out for file "${file.name}"`);
+				cleanup(void 0);
+			}, 1e4);
+			video.preload = "metadata";
+			video.muted = true;
+			video.playsInline = true;
+			video.onloadeddata = () => {
+				video.currentTime = .1;
+			};
+			video.onseeked = () => {
+				clearTimeout(timeout);
+				canvas.width = video.videoWidth;
+				canvas.height = video.videoHeight;
+				const ctx = canvas.getContext("2d");
+				if (ctx) {
+					ctx.drawImage(video, 0, 0);
+					cleanup(canvas.toDataURL("image/jpeg", .7));
+				} else {
+					console.warn("[CopilotKit] generateVideoThumbnail: could not get 2d canvas context");
+					cleanup(void 0);
+				}
+			};
+			video.onerror = () => {
+				clearTimeout(timeout);
+				console.warn(`[CopilotKit] generateVideoThumbnail: video element error for file "${file.name}"`);
+				cleanup(void 0);
+			};
+			video.src = url;
+		});
+	}
+	/**
+	* Check if a file's MIME type matches an accept filter string.
+	* Handles file extensions (e.g. ".pdf"), MIME wildcards ("image/*"), and comma-separated lists.
+	*/
+	function matchesAcceptFilter(file, accept) {
+		if (!accept || accept === "*/*") return true;
+		return accept.split(",").map((f) => f.trim()).some((filter) => {
+			if (filter.startsWith(".")) {
+				var _file$name;
+				return ((_file$name = file.name) !== null && _file$name !== void 0 ? _file$name : "").toLowerCase().endsWith(filter.toLowerCase());
+			}
+			if (filter.endsWith("/*")) {
+				const prefix = filter.slice(0, -2);
+				return file.type.startsWith(prefix + "/");
+			}
+			return file.type === filter;
+		});
+	}
+	/**
+	* Convert an InputContentSource to a usable URL string.
+	* For data sources, returns a base64 data URL; for URL sources, returns the URL directly.
+	*/
+	function getSourceUrl(source) {
+		if (source.type === "url") return source.value;
+		return `data:${source.mimeType};base64,${source.value}`;
+	}
+	/**
+	* Return a short human-readable label for a document MIME type (e.g. "PDF", "DOC").
+	*/
+	function getDocumentIcon(mimeType) {
+		if (mimeType.includes("pdf")) return "PDF";
+		if (mimeType.includes("sheet") || mimeType.includes("excel")) return "XLS";
+		if (mimeType.includes("presentation") || mimeType.includes("powerpoint")) return "PPT";
+		if (mimeType.includes("word") || mimeType.includes("document")) return "DOC";
+		if (mimeType.includes("text/")) return "TXT";
+		return "FILE";
+	}
+
 //#endregion
 //#region src/logger.ts
 	const logger = console;
@@ -1226,11 +1355,131 @@ ${getSeeMoreMarkdown(troubleshootingLink)}`;
 		})
 	};
 
+//#endregion
+//#region src/a2ui-prompts.ts
+/**
+	* Default A2UI generation and design guideline prompts.
+	*
+	* These are the canonical prompt fragments that instruct an LLM how to call
+	* the render_a2ui tool, how to bind data, and how to style surfaces.
+	*/
+	/**
+	* Generation guidelines — protocol rules, tool arguments, path rules,
+	* data model format, and form/two-way-binding instructions.
+	*/
+	const A2UI_DEFAULT_GENERATION_GUIDELINES = `\
+Generate A2UI v0.9 JSON.
+
+## A2UI Protocol Instructions
+
+A2UI (Agent to UI) is a protocol for rendering rich UI surfaces from agent responses.
+
+CRITICAL: You MUST call the render_a2ui tool with ALL of these arguments:
+- surfaceId: A unique ID for the surface (e.g. "product-comparison")
+- components: REQUIRED — the A2UI component array. NEVER omit this. Only use
+  components listed in the Available Components schema provided as context.
+- data: OPTIONAL — a JSON object written to the root of the surface data model.
+  Use for pre-filling form values or providing data for path-bound components.
+- every component must have the "component" field specifying the component type.
+  ONLY use component names from the Available Components schema — do NOT invent
+  component names or use names not in the schema.
+
+COMPONENT ID RULES:
+- Every component ID must be unique within the surface.
+- A component MUST NOT reference itself as child/children. This causes a
+  circular dependency error. For example, if a component has id="avatar",
+  its child must be a DIFFERENT id (e.g. "avatar-img"), never "avatar".
+- The child/children tree must be a DAG — no cycles allowed.
+
+REPEATING CONTENT (TEMPLATES):
+To repeat a component for each item in an array, use the structural children format:
+  children: { componentId: "card-id", path: "/items" }
+This tells the renderer to create one instance of "card-id" per item in the "/items" array.
+
+PATH RULES FOR TEMPLATES:
+Components inside a repeating template use RELATIVE paths (no leading slash).
+The path is resolved relative to each array item automatically.
+If a container has children: { componentId: "card", path: "/items" } and each item
+has a key "name", use { "path": "name" } (NO leading slash — relative to item).
+CRITICAL: Do NOT use "/name" (absolute) inside templates — use "name" (relative).
+The container's path ("/items") uses a leading slash (absolute), but all
+components INSIDE the template use paths WITHOUT leading slash.
+
+DATA MODEL:
+The "data" key in the tool args is a plain JSON object that initializes the surface
+data model. Components bound to paths (e.g. "value": { "path": "/form/name" })
+read from and write to this data model. Examples:
+  For forms:  "data": { "form": { "name": "Alice", "email": "" } }
+  For lists:  "data": { "items": [{"name": "Product A"}, {"name": "Product B"}] }
+  For mixed:  "data": { "form": { "query": "" }, "results": [...] }
+
+FORMS AND TWO-WAY DATA BINDING:
+To create editable forms, bind input components to data model paths using { "path": "..." }.
+The client automatically writes user input back to the data model at the bound path.
+CRITICAL: Using a literal value (e.g. "value": "") makes the field READ-ONLY.
+You MUST use { "path": "..." } to make inputs editable.
+
+Input components use "value" as the binding property:
+  "value": { "path": "/form/fieldName" }
+
+To retrieve form values when a button is clicked, include "context" with path references
+in the button's action. Paths are resolved to their current values at click time:
+  "action": { "event": { "name": "submit", "context": { "userName": { "path": "/form/name" } } } }
+
+To pre-fill form values, pass initial data via the "data" tool argument:
+  "data": { "form": { "name": "Markus" } }`;
+	/**
+	* Design guidelines — visual design rules, component hierarchy tips,
+	* and action handler patterns.
+	*/
+	const A2UI_DEFAULT_DESIGN_GUIDELINES = `\
+Create polished, visually appealing interfaces. ONLY use components listed in the
+Available Components schema — do NOT use component names that are not in the schema.
+
+Design principles:
+- Create clear visual hierarchy within cards and layouts.
+- Keep cards clean — avoid clutter. Whitespace is good.
+- Use consistent surfaceIds (lowercase, hyphenated).
+- NEVER use the same ID for a component and its child — this creates a
+  circular dependency. E.g. if id="avatar", child must NOT be "avatar".
+- For side-by-side comparisons, use a container with structural children
+  (children: { componentId, path }) to repeat a card template per data item.
+- Include images when relevant (logos, icons, product photos):
+  - Prefer company logos via Google favicons: https://www.google.com/s2/favicons?domain=example.com&sz=128
+  - Do NOT invent Unsplash photo-IDs — they will 404. Only use real, known URLs.
+- For buttons: action MUST use this exact nested format:
+    "action": { "event": { "name": "myAction", "context": { "key": "value" } } }
+  The "event" key holds an OBJECT with "name" (required) and "context" (optional).
+  Do NOT use a flat format like {"event": "name"} — "event" must be an object.
+- For forms: every input MUST use path binding on the "value" property
+  (e.g. "value": { "path": "/form/name" }) to be editable. The submit button's
+  action context MUST reference the same paths to capture the user's input.
+
+Use the SAME surfaceId as the main surface. Match action names to button action event names.`;
+
 //#endregion
 //#region src/index.ts
 	const COPILOTKIT_VERSION = version;
+	/**
+	* Client-safe license context factory.
+	*
+	* When status is null (no token provided), all features return true
+	* (unlicensed = unrestricted, with branding). This is inlined here to
+	* avoid importing the full license-verifier bundle (which depends on
+	* Node's `crypto`) into browser bundles.
+	*/
+	function createLicenseContextValue(status) {
+		return {
+			status: null,
+			license: null,
+			checkFeature: () => true,
+			getLimit: () => null
+		};
+	}
 
 //#endregion
+exports.A2UI_DEFAULT_DESIGN_GUIDELINES = A2UI_DEFAULT_DESIGN_GUIDELINES;
+exports.A2UI_DEFAULT_GENERATION_GUIDELINES = A2UI_DEFAULT_GENERATION_GUIDELINES;
 exports.AG_UI_CHANNEL_EVENT = AG_UI_CHANNEL_EVENT;
 exports.BANNER_ERROR_NAMES = BANNER_ERROR_NAMES;
 exports.COPILOTKIT_VERSION = COPILOTKIT_VERSION;
@@ -1265,11 +1514,18 @@ exports.TranscriptionErrors = TranscriptionErrors;
 exports.UpgradeRequiredError = UpgradeRequiredError;
 exports.actionParametersToJsonSchema = actionParametersToJsonSchema;
 exports.convertJsonSchemaToZodSchema = convertJsonSchemaToZodSchema;
+exports.createLicenseContextValue = createLicenseContextValue;
 exports.dataToUUID = dataToUUID;
 exports.ensureStructuredError = ensureStructuredError;
+exports.exceedsMaxSize = exceedsMaxSize;
 exports.executeConditions = executeConditions;
 exports.finalizeRunEvents = finalizeRunEvents;
+exports.formatFileSize = formatFileSize;
+exports.generateVideoThumbnail = generateVideoThumbnail;
+exports.getDocumentIcon = getDocumentIcon;
+exports.getModalityFromMimeType = getModalityFromMimeType;
 exports.getPossibleVersionMismatch = getPossibleVersionMismatch;
+exports.getSourceUrl = getSourceUrl;
 exports.getZodParameters = getZodParameters;
 exports.isMacOS = isMacOS;
 exports.isStructuredCopilotKitError = isStructuredCopilotKitError;
@@ -1279,6 +1535,7 @@ exports.jsonSchemaToActionParameters = jsonSchemaToActionParameters;
 exports.logCopilotKitPlatformMessage = logCopilotKitPlatformMessage;
 exports.logStyled = logStyled;
 exports.logger = logger;
+exports.matchesAcceptFilter = matchesAcceptFilter;
 exports.parseJson = parseJson;
 exports.partialJSONParse = partialJSONParse;
 exports.phoenixExponentialBackoff = phoenixExponentialBackoff;
@@ -1286,17 +1543,10 @@ exports.publicApiKeyRequired = publicApiKeyRequired;
 exports.randomId = randomId;
 exports.randomUUID = randomUUID;
 exports.readBody = readBody;
+exports.readFileAsBase64 = readFileAsBase64;
 exports.safeParseToolArgs = safeParseToolArgs;
 exports.schemaToJsonSchema = schemaToJsonSchema;
 exports.styledConsole = styledConsole;
 exports.tryMap = tryMap;
-var _copilotkit_license_verifier = require("@copilotkit/license-verifier");
-Object.keys(_copilotkit_license_verifier).forEach(function (k) {
-  if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () { return _copilotkit_license_verifier[k]; }
-  });
-});
-
 });
 //# sourceMappingURL=index.umd.js.map