@takeshape/schema 11.102.4 → 11.103.3

package/dist/project-schema/v3.56.0.js

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export {};

package/dist/resolvers/ai/abort-agent-message-args.d.ts

@@ -0,0 +1,16 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const schema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly messageId: {
+            readonly type: "string";
+            readonly description: "Message ID to send an abort signal for";
+        };
+    };
+    readonly required: ["messageId"];
+    readonly additionalProperties: false;
+};
+export type AbortAgentMessageArgs = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    messageId: string;
+}>;

package/dist/resolvers/ai/abort-agent-message-args.js

@@ -0,0 +1,13 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+export const schema = {
+    type: 'object',
+    properties: {
+        messageId: {
+            type: 'string',
+            description: 'Message ID to send an abort signal for'
+        }
+    },
+    required: ['messageId'],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);

package/dist/resolvers/ai/abort-agent-message-response.d.ts

@@ -0,0 +1,26 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const shapeName = "TSAbortAgentMessageResponse";
+export declare const schema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly aborted: {
+            readonly type: "object";
+            readonly properties: {
+                readonly messageId: {
+                    readonly type: "string";
+                    readonly description: "The ID of the aborted deferred message";
+                };
+            };
+            readonly required: ["messageId"];
+            readonly additionalProperties: false;
+        };
+    };
+    readonly required: [];
+    readonly additionalProperties: false;
+};
+export type AbortAgentMessageResponse = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    aborted?: {
+        messageId: string;
+    } | undefined;
+}>;

package/dist/resolvers/ai/abort-agent-message-response.js

@@ -0,0 +1,19 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+import { AI_AGENT_ABORT_AGENT_MESSAGE_RESPONSE_SHAPE_NAME } from "./constants.js";
+export const shapeName = AI_AGENT_ABORT_AGENT_MESSAGE_RESPONSE_SHAPE_NAME;
+export const schema = {
+    type: 'object',
+    properties: {
+        aborted: {
+            type: 'object',
+            properties: {
+                messageId: { type: 'string', description: 'The ID of the aborted deferred message' }
+            },
+            required: ['messageId'],
+            additionalProperties: false
+        }
+    },
+    required: [],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);

package/dist/resolvers/ai/agent-chat-args.d.ts

@@ -0,0 +1,17 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const shapeName = "TSChatArgs";
+export declare const schema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly input: {
+            readonly type: "string";
+            readonly description: "The chat message input from the user.";
+        };
+    };
+    readonly required: ["input"];
+    readonly additionalProperties: false;
+};
+export type AgentChatArgs = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    input: string;
+}>;

package/dist/resolvers/ai/agent-chat-args.js

@@ -0,0 +1,15 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+import { AI_AGENT_CHAT_ARGS_SHAPE_NAME } from "./constants.js";
+export const shapeName = AI_AGENT_CHAT_ARGS_SHAPE_NAME;
+export const schema = {
+    type: 'object',
+    properties: {
+        input: {
+            type: 'string',
+            description: 'The chat message input from the user.'
+        }
+    },
+    required: ['input'],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);

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

@@ -0,0 +1,35 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const shapeName = "TSChatPayload";
+export declare const schema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly content: {
+            readonly type: "string";
+            readonly description: "The string content of the chat message.";
+        };
+        readonly references: {
+            readonly type: "array";
+            readonly items: {
+                readonly type: "object";
+                readonly '@ref': "TSReference";
+            };
+            readonly description: "A list of references associated with the chat message.";
+        };
+        readonly artifact: {
+            readonly type: "object";
+            readonly description: "An optional artifact associated with the chat message.";
+        };
+    };
+    readonly required: ["content", "references"];
+    readonly additionalProperties: false;
+};
+export type AgentChatPayload = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    artifact?: {
+        [x: string]: unknown;
+    } | undefined;
+    content: string;
+    references: {
+        [x: string]: unknown;
+    }[];
+}>;

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

@@ -0,0 +1,27 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+import { AI_AGENT_CHAT_PAYLOAD_SHAPE_NAME } from "./constants.js";
+export const shapeName = AI_AGENT_CHAT_PAYLOAD_SHAPE_NAME;
+export const schema = {
+    type: 'object',
+    properties: {
+        content: {
+            type: 'string',
+            description: 'The string content of the chat message.'
+        },
+        references: {
+            type: 'array',
+            items: {
+                type: 'object',
+                '@ref': 'TSReference'
+            },
+            description: 'A list of references associated with the chat message.'
+        },
+        artifact: {
+            type: 'object',
+            description: 'An optional artifact associated with the chat message.'
+        }
+    },
+    required: ['content', 'references'],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);

package/dist/resolvers/ai/agent-chat-response.d.ts

@@ -0,0 +1,136 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const shapeName = "TSChatResponse";
+export declare const schema: {
+    readonly properties: {
+        readonly output: {
+            readonly type: "object";
+            readonly properties: {
+                readonly content: {
+                    readonly type: "string";
+                    readonly description: "The string content of the chat message.";
+                };
+                readonly references: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "object";
+                        readonly '@ref': "TSReference";
+                    };
+                    readonly description: "A list of references associated with the chat message.";
+                };
+                readonly artifact: {
+                    readonly type: "object";
+                    readonly description: "An optional artifact associated with the chat message.";
+                };
+            };
+            readonly required: ["content", "references"];
+            readonly additionalProperties: false;
+        };
+        readonly messageId: {
+            readonly type: "string";
+            readonly description: "The unique identifier for the agent run response message.";
+        };
+        readonly session: {
+            readonly type: "object";
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                    readonly description: "The unique identifier for the agent session.";
+                };
+                readonly agentName: {
+                    readonly type: "string";
+                    readonly description: "The name of the agent associated with this session.";
+                };
+                readonly projectId: {
+                    readonly type: "string";
+                    readonly description: "The ID of the project to which this agent session belongs.";
+                };
+                readonly schemaId: {
+                    readonly type: "string";
+                    readonly description: "The schema ID associated with the agent session, typically in the format \"production~projectId\".";
+                };
+                readonly done: {
+                    readonly type: "boolean";
+                    readonly description: "Indicates whether the agent session is completed.";
+                };
+                readonly suspended: {
+                    readonly type: "boolean";
+                    readonly description: "Indicates whether the agent session is suspended.";
+                };
+                readonly previousStateId: {
+                    readonly type: "string";
+                    readonly description: "The ID of the previous state in the agent session, if any.";
+                };
+                readonly currentStateId: {
+                    readonly type: "string";
+                    readonly description: "The ID of the current state in the agent session.";
+                };
+                readonly chatSessionIds: {
+                    readonly type: "object";
+                    readonly description: "A mapping of chat session IDs to their corresponding state IDs.";
+                };
+                readonly sessionMemory: {
+                    readonly type: "object";
+                    readonly description: "Memory associated with the agent session, which can be used to store stateful information.";
+                };
+                readonly stateOutputs: {
+                    readonly type: "object";
+                    readonly description: "Outputs from the states in the agent session, keyed by state ID.";
+                };
+                readonly currentValue: {
+                    readonly type: "object";
+                    readonly description: "The current value of the agent session, which may be updated as the session progresses.";
+                };
+                readonly hasAgentHistory: {
+                    readonly type: "boolean";
+                    readonly description: "Indicates whether the agent session has an associated history of agent responses.";
+                };
+            };
+            readonly required: ["id", "agentName", "done", "currentStateId", "chatSessionIds", "sessionMemory", "stateOutputs", "projectId", "schemaId"];
+            readonly additionalProperties: false;
+        };
+        readonly runMode: {
+            readonly enum: ["BACKGROUND", "IMMEDIATE"];
+            readonly description: "Indicates how the agent message was run";
+        };
+    };
+    readonly additionalProperties: false;
+    readonly required: ["messageId", "session", "runMode", "output"];
+    readonly type: "object";
+};
+export type AgentChatResponse = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    messageId: string;
+    output: {
+        artifact?: {
+            [x: string]: unknown;
+        } | undefined;
+        content: string;
+        references: {
+            [x: string]: unknown;
+        }[];
+    };
+    runMode: "BACKGROUND" | "IMMEDIATE";
+    session: {
+        suspended?: boolean | undefined;
+        previousStateId?: string | undefined;
+        currentValue?: {
+            [x: string]: unknown;
+        } | undefined;
+        hasAgentHistory?: boolean | undefined;
+        id: string;
+        agentName: string;
+        projectId: string;
+        schemaId: string;
+        done: boolean;
+        currentStateId: string;
+        chatSessionIds: {
+            [x: string]: unknown;
+        };
+        sessionMemory: {
+            [x: string]: unknown;
+        };
+        stateOutputs: {
+            [x: string]: unknown;
+        };
+    };
+}>;

package/dist/resolvers/ai/agent-chat-response.js

@@ -0,0 +1,17 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+import * as agentChatPayload from "./agent-chat-payload.js";
+import { AI_AGENT_CHAT_RESPONSE_SHAPE_NAME } from "./constants.js";
+import * as sendAgentMessageResponse from "./send-agent-message-response.js";
+export const shapeName = AI_AGENT_CHAT_RESPONSE_SHAPE_NAME;
+export const schema = {
+    ...sendAgentMessageResponse.schema,
+    properties: {
+        ...sendAgentMessageResponse.schema.properties,
+        output: {
+            ...agentChatPayload.schema
+        }
+    },
+    additionalProperties: false,
+    required: [...sendAgentMessageResponse.schema.required, 'output']
+};
+export const validate = createTypedValidator(schema);

package/dist/resolvers/ai/agent-generate-args.d.ts

@@ -0,0 +1,17 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const shapeName = "TSGenerateArgs";
+export declare const schema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly input: {
+            readonly type: "string";
+            readonly description: "The generate message input from the user.";
+        };
+    };
+    readonly required: ["input"];
+    readonly additionalProperties: false;
+};
+export type AgentGenerateArgs = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    input: string;
+}>;

package/dist/resolvers/ai/agent-generate-args.js

@@ -0,0 +1,15 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+import { AI_AGENT_GENERATE_ARGS_SHAPE_NAME } from "./constants.js";
+export const shapeName = AI_AGENT_GENERATE_ARGS_SHAPE_NAME;
+export const schema = {
+    type: 'object',
+    properties: {
+        input: {
+            type: 'string',
+            description: 'The generate message input from the user.'
+        }
+    },
+    required: ['input'],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);

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

@@ -0,0 +1,84 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const schema: {
+    readonly $id: "https://takeshape.io/schema/agent-message-payload";
+    readonly type: "object";
+    readonly properties: {
+        readonly messageId: {
+            readonly type: "string";
+            readonly description: "ID of the message that was deferred";
+        };
+        readonly sessionId: {
+            readonly type: "string";
+            readonly description: "ID of the session this message belongs to";
+        };
+        readonly projectId: {
+            readonly type: "string";
+            readonly description: "Project ID of the project this message belongs to";
+        };
+        readonly input: {
+            readonly type: "object";
+        };
+        readonly output: {
+            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 required: ["messageId", "sessionId", "projectId", "runMode"];
+    readonly additionalProperties: false;
+};
+export type AgentMessagePayload = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<{
+    input?: {
+        [x: string]: unknown;
+    } | undefined;
+    output?: {
+        [x: string]: unknown;
+    } | undefined;
+    error?: {
+        message?: string | undefined;
+        name?: string | undefined;
+        code?: string | undefined;
+    } | undefined;
+    abortedAt?: number | undefined;
+    sentAt?: number | undefined;
+    startedAt?: number | undefined;
+    finishedAt?: number | undefined;
+    messageId: string;
+    projectId: string;
+    sessionId: string;
+    runMode: "BACKGROUND" | "IMMEDIATE";
+}>;

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

@@ -0,0 +1,57 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+export const schema = {
+    $id: 'https://takeshape.io/schema/agent-message-payload',
+    type: 'object',
+    properties: {
+        messageId: {
+            type: 'string',
+            description: 'ID of the message that was deferred'
+        },
+        sessionId: {
+            type: 'string',
+            description: 'ID of the session this message belongs to'
+        },
+        projectId: {
+            type: 'string',
+            description: 'Project ID of the project this message belongs to'
+        },
+        input: {
+            type: 'object'
+        },
+        output: {
+            type: 'object'
+        },
+        error: {
+            type: 'object',
+            properties: {
+                message: { type: 'string' },
+                name: { type: 'string' },
+                code: { type: 'string' }
+            },
+            additionalProperties: false
+        },
+        runMode: {
+            enum: ['BACKGROUND', 'IMMEDIATE'],
+            description: 'Indicates how the agent message was run'
+        },
+        abortedAt: {
+            type: 'number',
+            description: 'Timestamp when the message was aborted'
+        },
+        sentAt: {
+            type: 'number',
+            description: 'Timestamp when the message was sent'
+        },
+        startedAt: {
+            type: 'number',
+            description: 'Timestamp when the message started processing'
+        },
+        finishedAt: {
+            type: 'number',
+            description: 'Timestamp when the message finished processing'
+        }
+    },
+    required: ['messageId', 'sessionId', 'projectId', 'runMode'],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);

package/dist/resolvers/ai/agent-run-mode.d.ts

@@ -0,0 +1,7 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const shapeName = "TSAgentRunMode";
+export declare const schema: {
+    readonly enum: ["ALLOW_BACKGROUND", "BACKGROUND", "IMMEDIATE"];
+};
+export type AgentRunMode = FromSchema<typeof schema>;
+export declare const validate: import("ajv").ValidateFunction<"BACKGROUND" | "IMMEDIATE" | "ALLOW_BACKGROUND">;

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

@@ -0,0 +1,10 @@
+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 schema = {
+    enum: [...runModes]
+    // description:
+    //   'The mode in which the agent should run. "ALLOW_BACKGROUND" allows runs that would timeout to run longer in the background, "BACKGROUND" only runs in the background and results will need to be polled for. "IMMEDIATE" runs immediately and will timeout if it takes too long.'
+};
+export const validate = createTypedValidator(schema);

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

@@ -0,0 +1,67 @@
+import type { AgentSessionValue, AgentSessionValueOutput } from '@takeshape/util';
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const schema: {
+    readonly type: "object";
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "The unique identifier for the agent session.";
+        };
+        readonly agentName: {
+            readonly type: "string";
+            readonly description: "The name of the agent associated with this session.";
+        };
+        readonly projectId: {
+            readonly type: "string";
+            readonly description: "The ID of the project to which this agent session belongs.";
+        };
+        readonly schemaId: {
+            readonly type: "string";
+            readonly description: "The schema ID associated with the agent session, typically in the format \"production~projectId\".";
+        };
+        readonly done: {
+            readonly type: "boolean";
+            readonly description: "Indicates whether the agent session is completed.";
+        };
+        readonly suspended: {
+            readonly type: "boolean";
+            readonly description: "Indicates whether the agent session is suspended.";
+        };
+        readonly previousStateId: {
+            readonly type: "string";
+            readonly description: "The ID of the previous state in the agent session, if any.";
+        };
+        readonly currentStateId: {
+            readonly type: "string";
+            readonly description: "The ID of the current state in the agent session.";
+        };
+        readonly chatSessionIds: {
+            readonly type: "object";
+            readonly description: "A mapping of chat session IDs to their corresponding state IDs.";
+        };
+        readonly sessionMemory: {
+            readonly type: "object";
+            readonly description: "Memory associated with the agent session, which can be used to store stateful information.";
+        };
+        readonly stateOutputs: {
+            readonly type: "object";
+            readonly description: "Outputs from the states in the agent session, keyed by state ID.";
+        };
+        readonly currentValue: {
+            readonly type: "object";
+            readonly description: "The current value of the agent session, which may be updated as the session progresses.";
+        };
+        readonly hasAgentHistory: {
+            readonly type: "boolean";
+            readonly description: "Indicates whether the agent session has an associated history of agent responses.";
+        };
+    };
+    readonly required: ["id", "agentName", "done", "currentStateId", "chatSessionIds", "sessionMemory", "stateOutputs", "projectId", "schemaId"];
+    readonly additionalProperties: false;
+};
+export type AgentSessionPayload = FromSchema<typeof schema> & {
+    stateOutputs: Record<string, AgentSessionValueOutput | undefined>;
+    suspended?: boolean;
+    currentValue?: AgentSessionValue;
+};
+export declare const validate: import("ajv").ValidateFunction<AgentSessionPayload>;