@takeshape/schema 11.133.4 → 11.142.5

package/dist/resolvers/ai/agent-message-payload.d.ts

@@ -1,69 +1,7 @@
 import type { AiUsage } from '@takeshape/util';
 import type { CoreMessage } from 'ai';
 import type { FromSchema } from 'json-schema-to-ts';
-export declare const agentGenerateStateOutputSchema: {
-    readonly title: "AgentGenerateStateOutput";
-    readonly type: "object";
-    readonly properties: {
-        readonly type: {
-            readonly const: "generate";
-        };
-        readonly data: {};
-    };
-    readonly required: ["type", "data"];
-    readonly additionalProperties: false;
-};
-export declare const agentGraphQLStateOutputSchema: {
-    readonly title: "AgentGraphQLStateOutput";
-    readonly type: "object";
-    readonly properties: {
-        readonly type: {
-            readonly const: "graphql";
-        };
-        readonly data: {};
-    };
-    readonly required: ["type", "data"];
-    readonly additionalProperties: false;
-};
-export declare const agentChatStateOutputSchema: {
-    readonly title: "AgentChatStateOutput";
-    readonly type: "object";
-    readonly properties: {
-        readonly type: {
-            readonly const: "chat";
-        };
-        readonly data: {
-            readonly title: "AgentChatStateOutputData";
-            readonly type: "object";
-            readonly properties: {
-                readonly content: {
-                    readonly type: "string";
-                };
-                readonly artifact: {
-                    readonly type: "object";
-                };
-                readonly references: {
-                    readonly type: "array";
-                    readonly items: {
-                        readonly title: "AgentChatStateOutputReference";
-                        readonly type: "object";
-                        readonly properties: {
-                            readonly _tid: {
-                                readonly type: "string";
-                            };
-                        };
-                        readonly required: ["_tid"];
-                        readonly additionalProperties: false;
-                    };
-                };
-            };
-            readonly required: ["content", "references"];
-            readonly additionalProperties: false;
-        };
-    };
-    readonly required: ["type", "data"];
-    readonly additionalProperties: false;
-};
+export declare const shapeName = "TSAgentMessage";
 export declare const schema: {
     readonly $id: "https://takeshape.io/schema/agent-message-payload";
     readonly type: "object";
@@ -92,14 +30,45 @@ export declare const schema: {
             readonly type: "object";
         };
         readonly input: {
-            readonly type: "string";
+            readonly title: "TSAgentMessageInput";
+            readonly description: "The input schema for agent messages.";
+            readonly discriminator: {
+                readonly propertyName: "type";
+            };
+            readonly oneOf: [{
+                readonly title: "TSAgentMessageUnknownInput";
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "unknown";
+                    };
+                    readonly data: {};
+                };
+                readonly required: ["type", "data"];
+                readonly additionalProperties: false;
+            }, {
+                readonly title: "TSAgentMessageStringInput";
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "string";
+                    };
+                    readonly content: {
+                        readonly type: "string";
+                    };
+                };
+                readonly required: ["type", "content"];
+                readonly additionalProperties: false;
+            }];
         };
         readonly output: {
+            readonly title: "TSAgentMessageOutput";
+            readonly description: "The output schema for agent messages.";
             readonly discriminator: {
                 readonly propertyName: "type";
             };
             readonly oneOf: [{
-                readonly title: "AgentGenerateStateOutput";
+                readonly title: "TSAgentGenerateStateOutput";
                 readonly type: "object";
                 readonly properties: {
                     readonly type: {
@@ -110,7 +79,7 @@ export declare const schema: {
                 readonly required: ["type", "data"];
                 readonly additionalProperties: false;
             }, {
-                readonly title: "AgentGraphQLStateOutput";
+                readonly title: "TSAgentGraphQLStateOutput";
                 readonly type: "object";
                 readonly properties: {
                     readonly type: {
@@ -121,14 +90,13 @@ export declare const schema: {
                 readonly required: ["type", "data"];
                 readonly additionalProperties: false;
             }, {
-                readonly title: "AgentChatStateOutput";
+                readonly title: "TSAgentChatStateOutput";
                 readonly type: "object";
                 readonly properties: {
                     readonly type: {
                         readonly const: "chat";
                     };
                     readonly data: {
-                        readonly title: "AgentChatStateOutputData";
                         readonly type: "object";
                         readonly properties: {
                             readonly content: {
@@ -140,7 +108,6 @@ export declare const schema: {
                             readonly references: {
                                 readonly type: "array";
                                 readonly items: {
-                                    readonly title: "AgentChatStateOutputReference";
                                     readonly type: "object";
                                     readonly properties: {
                                         readonly _tid: {
@@ -159,7 +126,7 @@ export declare const schema: {
                 readonly required: ["type", "data"];
                 readonly additionalProperties: false;
             }, {
-                readonly title: "AgentUnknownStateOutput";
+                readonly title: "TSAgentUnknownStateOutput";
                 readonly type: "object";
                 readonly properties: {
                     readonly type: {
@@ -170,7 +137,6 @@ export declare const schema: {
                 readonly required: ["type", "data"];
                 readonly additionalProperties: false;
             }];
-            readonly required: ["type"];
         };
         readonly error: {
             readonly type: "object";
@@ -307,7 +273,13 @@ export declare const validate: import("ajv").ValidateFunction<{
     args?: {
         [x: string]: unknown;
     } | undefined;
-    input?: string | undefined;
+    input?: {
+        type: "unknown";
+        data: unknown;
+    } | {
+        type: "string";
+        content: string;
+    } | undefined;
     output?: {
         type: "generate";
         data: unknown;
@@ -354,9 +326,9 @@ export declare const validate: import("ajv").ValidateFunction<{
     } | undefined;
     blocked?: boolean | undefined;
     usage?: {
+        totalTokens?: number | undefined;
         completionTokens?: number | undefined;
         promptTokens?: number | undefined;
-        totalTokens?: number | undefined;
         guardrailUnits?: number | undefined;
     } | undefined;
     messageId: string;
@@ -385,9 +357,151 @@ export type AgentGenerateStateExecuteResult = {
     };
 };
 export type AgentGraphQLStateExecuteResult = {
+    input: unknown;
     output: AgentGraphQLStateOutput;
 };
 export type AgentStateExecuteResult = AgentChatStateExecuteResult | AgentGenerateStateExecuteResult | AgentGraphQLStateExecuteResult;
 export type AgentChatStateExecuteResultWithoutMetadata = Omit<AgentChatStateExecuteResult, 'metadata'>;
 export type AgentGenerateStateExecuteResultWithoutMetadata = Omit<AgentGenerateStateExecuteResult, 'metadata'>;
 export type AgentStateExecuteResultWithoutMetadata = AgentChatStateExecuteResultWithoutMetadata | AgentGenerateStateExecuteResultWithoutMetadata | AgentGraphQLStateExecuteResult;
+export type AgentMessageShapePayload<Output = unknown> = Omit<AgentMessagePayload, 'output'> & {
+    output: Output;
+};
+export declare const shapeSchema: {
+    readonly properties: {
+        readonly input: {
+            readonly '@ref': "TSAgentMessageInput";
+        };
+        readonly output: {
+            readonly '@ref': "TSAgentMessageOutput";
+        };
+        readonly messageId: {
+            readonly type: "string";
+            readonly description: "ID of the message that was deferred";
+        };
+        readonly agentName: {
+            readonly type: "string";
+            readonly description: "Name of the agent this message was created by";
+        };
+        readonly args: {
+            readonly type: "object";
+        };
+        readonly error: {
+            readonly type: "object";
+            readonly properties: {
+                readonly message: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly code: {
+                    readonly type: "string";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+        readonly runMode: {
+            readonly enum: ["BACKGROUND", "IMMEDIATE"];
+            readonly description: "Indicates how the agent message was run";
+        };
+        readonly abortedAt: {
+            readonly type: "number";
+            readonly description: "Timestamp when the message was aborted";
+        };
+        readonly sentAt: {
+            readonly type: "number";
+            readonly description: "Timestamp when the message was sent";
+        };
+        readonly startedAt: {
+            readonly type: "number";
+            readonly description: "Timestamp when the message started processing";
+        };
+        readonly finishedAt: {
+            readonly type: "number";
+            readonly description: "Timestamp when the message finished processing";
+        };
+        readonly span: {
+            readonly type: "object";
+            readonly description: "The span for the agent run associated with this message";
+            readonly properties: {
+                readonly traceId: {
+                    readonly type: "string";
+                };
+                readonly spanId: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly createdAt: {
+                    readonly type: "number";
+                };
+            };
+            readonly required: ["traceId", "spanId", "name", "createdAt"];
+            readonly additionalProperties: false;
+        };
+        readonly feedback: {
+            readonly type: "object";
+            readonly properties: {
+                readonly name: {
+                    readonly type: "string";
+                    readonly description: "Name of the feedback, e.g., \"Quality\", \"Relevance\"";
+                };
+                readonly label: {
+                    readonly type: "string";
+                    readonly description: "String feedback for the agent message, e.g., \"helpful\", \"not helpful\". If a label is provided, a score must not be provided.";
+                };
+                readonly score: {
+                    readonly type: "number";
+                    readonly description: "Numeric feedback for the agent message, typically between 1 and 5. If a score is provided, a label must not be provided.";
+                };
+                readonly text: {
+                    readonly type: "string";
+                    readonly description: "Freeform text feedback for the agent message.";
+                };
+                readonly note: {
+                    readonly type: "string";
+                    readonly description: "Optional note for the feedback, e.g., \"This was helpful because...\"";
+                };
+                readonly updatedBy: {
+                    readonly type: "string";
+                    readonly description: "A string identifying the user who is adding the annotation, such as a name or email address.";
+                };
+                readonly createdAt: {
+                    readonly type: "number";
+                    readonly description: "Timestamp when the feedback was created";
+                };
+            };
+            readonly additionalProperties: false;
+            readonly required: ["name"];
+        };
+        readonly blocked: {
+            readonly type: "boolean";
+            readonly description: "If this message was blocked by a guardrail";
+        };
+        readonly usage: {
+            readonly type: "object";
+            readonly description: "LLM token usage for this message";
+            readonly properties: {
+                readonly completionTokens: {
+                    readonly type: "number";
+                };
+                readonly promptTokens: {
+                    readonly type: "number";
+                };
+                readonly totalTokens: {
+                    readonly type: "number";
+                };
+                readonly guardrailUnits: {
+                    readonly type: "number";
+                };
+            };
+            readonly additionalProperties: false;
+        };
+    };
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly required: ["messageId", "sessionId", "agentName", "projectId", "schemaId", "runMode", "sentAt"];
+    readonly title: "TSAgentMessage";
+};

package/dist/resolvers/ai/agent-message-payload.js

@@ -1,65 +1,8 @@
 import { createTypedValidator } from '@takeshape/json-schema';
-export const agentGenerateStateOutputSchema = {
-    title: 'AgentGenerateStateOutput',
-    type: 'object',
-    properties: {
-        type: { const: 'generate' },
-        data: {}
-    },
-    required: ['type', 'data'],
-    additionalProperties: false
-};
-export const agentGraphQLStateOutputSchema = {
-    title: 'AgentGraphQLStateOutput',
-    type: 'object',
-    properties: {
-        type: { const: 'graphql' },
-        data: {}
-    },
-    required: ['type', 'data'],
-    additionalProperties: false
-};
-export const agentChatStateOutputSchema = {
-    title: 'AgentChatStateOutput',
-    type: 'object',
-    properties: {
-        type: { const: 'chat' },
-        data: {
-            title: 'AgentChatStateOutputData',
-            type: 'object',
-            properties: {
-                content: { type: 'string' },
-                artifact: { type: 'object' },
-                references: {
-                    type: 'array',
-                    items: {
-                        title: 'AgentChatStateOutputReference',
-                        type: 'object',
-                        properties: {
-                            _tid: { type: 'string' }
-                        },
-                        required: ['_tid'],
-                        additionalProperties: false
-                    }
-                }
-            },
-            required: ['content', 'references'],
-            additionalProperties: false
-        }
-    },
-    required: ['type', 'data'],
-    additionalProperties: false
-};
-const agentUnknownStateOutputSchema = {
-    title: 'AgentUnknownStateOutput',
-    type: 'object',
-    properties: {
-        type: { const: 'unknown' },
-        data: {}
-    },
-    required: ['type', 'data'],
-    additionalProperties: false
-};
+import omit from 'lodash/omit.js';
+import * as agentMessageInput from "./agent-message-input.js";
+import * as agentMessageOutput from "./agent-message-output.js";
+export const shapeName = 'TSAgentMessage';
 export const schema = {
     $id: 'https://takeshape.io/schema/agent-message-payload',
     type: 'object',
@@ -88,19 +31,10 @@ export const schema = {
             type: 'object'
         },
         input: {
-            type: 'string'
+            ...agentMessageInput.schema
         },
         output: {
-            discriminator: {
-                propertyName: 'type'
-            },
-            oneOf: [
-                agentGenerateStateOutputSchema,
-                agentGraphQLStateOutputSchema,
-                agentChatStateOutputSchema,
-                agentUnknownStateOutputSchema
-            ],
-            required: ['type']
+            ...agentMessageOutput.schema
         },
         error: {
             type: 'object',
@@ -206,3 +140,17 @@ export const schema = {
     additionalProperties: false
 };
 export const validate = createTypedValidator(schema);
+const { sessionId, projectId, schemaId, ...shapeSchemaProperties } = schema.properties;
+export const shapeSchema = {
+    title: shapeName,
+    ...omit(schema, ['$id']),
+    properties: {
+        ...shapeSchemaProperties,
+        input: {
+            '@ref': agentMessageInput.shapeName
+        },
+        output: {
+            '@ref': agentMessageOutput.shapeName
+        }
+    }
+};

package/dist/resolvers/ai/agent-run-mode.js

@@ -1,7 +1,6 @@
 import { createTypedValidator } from '@takeshape/json-schema';
-import { AI_AGENT_RUN_MODE_SHAPE_NAME } from "./constants.js";
 const runModes = ['ALLOW_BACKGROUND', 'BACKGROUND', 'IMMEDIATE'];
-export const shapeName = AI_AGENT_RUN_MODE_SHAPE_NAME;
+export const shapeName = 'TSAgentRunMode';
 export const schema = {
     enum: [...runModes]
     // description: