@takeshape/schema 12.1.1 → 12.1.5

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

@@ -0,0 +1,218 @@
+import { createTypedValidator } from '@takeshape/json-schema';
+import * as agentMessageInput from "./agent-message-input.js";
+import * as agentMessageOutput from "./agent-message-output.js";
+import * as aiUsageItem from "./ai-usage-item.js";
+export const shapeName = 'TSAgentSession';
+export const recordSchema = {
+    title: shapeName,
+    type: 'object',
+    properties: {
+        id: {
+            type: 'string',
+            description: 'The unique identifier for the agent session.'
+        },
+        createdAt: {
+            type: 'string',
+            description: 'ISO8601 timestamp when the agent session was created',
+            format: 'date-time'
+        },
+        updatedAt: {
+            type: 'string',
+            description: 'ISO8601 timestamp when the agent session was updated',
+            format: 'date-time'
+        },
+        agentName: {
+            type: 'string',
+            description: 'The name of the agent associated with this session.'
+        },
+        projectId: {
+            type: 'string',
+            description: 'The ID of the project to which this agent session belongs.'
+        },
+        schemaId: {
+            type: 'string',
+            description: 'The schema ID associated with the agent session, typically in the format "production~projectId".'
+        },
+        schemaHash: {
+            type: 'string',
+            description: 'The hash of the schema version associated with the agent session.'
+        },
+        done: {
+            type: 'boolean',
+            description: 'Indicates whether the agent session is completed.'
+        },
+        suspended: {
+            type: 'boolean',
+            description: 'Indicates whether the agent session is suspended.'
+        },
+        previousStateId: {
+            type: 'string',
+            description: 'The ID of the previous state in the agent session, if any.'
+        },
+        currentStateId: {
+            type: 'string',
+            description: 'The ID of the current state in the agent session.'
+        },
+        chatSessionIds: {
+            type: 'object',
+            description: 'A mapping of chat session IDs to their corresponding state IDs.'
+        },
+        sessionMemory: {
+            type: 'object',
+            description: 'Memory associated with the agent session, which can be used to store stateful information.'
+        },
+        hasAgentHistory: {
+            type: 'boolean',
+            description: 'Indicates whether the agent session has an associated history of agent responses.'
+        },
+        hasFeedback: {
+            type: 'boolean',
+            description: 'Indicates whether the agent session has any messages with feedback.'
+        },
+        suspend: {
+            type: 'boolean',
+            description: 'Indicates whether the agent session is suspended.'
+        },
+        suspendedTransitionIndices: {
+            type: 'array',
+            description: 'An array of indices of suspended transitions in the agent session.',
+            items: {
+                type: 'integer'
+            }
+        },
+        firstMessageInput: {
+            ...agentMessageInput.schema
+        },
+        lastMessageOutput: {
+            ...agentMessageOutput.schema
+        },
+        totalTokens: {
+            type: 'number',
+            description: 'The total number of tokens used in the agent session.'
+        },
+        domain: {
+            type: 'string',
+            description: 'The domain from which the agent session was created (e.g., "shop.example.com", "app.takeshape.io").'
+        },
+        takeshapeUserId: {
+            type: 'string',
+            description: 'The TakeShape user ID if the session was created by a TakeShape user (via JWT or PAT).'
+        },
+        usage: {
+            type: 'array',
+            description: 'Itemized token usage breakdown by service and model across all messages',
+            items: aiUsageItem.schema
+        },
+        // Below are for records
+        __createdRegion: {
+            type: 'string'
+        },
+        __updatedRegion: {
+            type: 'string'
+        },
+        ttl: {
+            type: 'integer'
+        },
+        schemaIdAgentName: {
+            type: 'string'
+        }
+    },
+    required: [
+        '__createdRegion',
+        '__updatedRegion',
+        'ttl',
+        'schemaIdAgentName',
+        'id',
+        'agentName',
+        'createdAt',
+        'updatedAt',
+        'done',
+        'currentStateId',
+        'chatSessionIds',
+        'sessionMemory',
+        'hasAgentHistory',
+        'hasFeedback',
+        'suspend',
+        'projectId',
+        'schemaId',
+        'schemaHash',
+        'totalTokens'
+    ],
+    additionalProperties: false
+};
+const { __createdRegion, __updatedRegion, ttl, schemaIdAgentName, ...schemaProperties } = recordSchema.properties;
+export const schema = {
+    ...recordSchema,
+    properties: {
+        ...schemaProperties
+    },
+    required: [
+        'id',
+        'agentName',
+        'createdAt',
+        'updatedAt',
+        'done',
+        'currentStateId',
+        'chatSessionIds',
+        'sessionMemory',
+        'hasAgentHistory',
+        'hasFeedback',
+        'suspend',
+        'projectId',
+        'schemaId',
+        'schemaHash',
+        'totalTokens'
+    ],
+    additionalProperties: false
+};
+export const validate = createTypedValidator(schema);
+const { projectId, schemaId, schemaHash, firstMessageInput, lastMessageOutput, suspendedTransitionIndices, chatSessionIds, previousStateId, ...shapeSchemaProperties } = schema.properties;
+// Schema for user-facing responses - used for TypeScript type derivation (no @ref)
+export const userSchema = {
+    ...schema,
+    properties: {
+        ...shapeSchemaProperties
+    },
+    required: [
+        'id',
+        'agentName',
+        'createdAt',
+        'updatedAt',
+        'done',
+        'sessionMemory',
+        'hasAgentHistory',
+        'hasFeedback',
+        'suspend',
+        'currentStateId',
+        'totalTokens'
+    ],
+    additionalProperties: false
+};
+// Schema for GraphQL shape generation (uses @ref)
+export const shapeSchema = {
+    ...schema,
+    properties: {
+        ...shapeSchemaProperties,
+        usage: {
+            type: 'array',
+            description: 'Itemized token usage breakdown by service and model across all messages',
+            items: {
+                '@ref': aiUsageItem.shapeName
+            }
+        }
+    },
+    required: [
+        'id',
+        'agentName',
+        'createdAt',
+        'updatedAt',
+        'done',
+        'sessionMemory',
+        'hasAgentHistory',
+        'hasFeedback',
+        'suspend',
+        'currentStateId',
+        'totalTokens'
+    ],
+    additionalProperties: false
+};

package/dist/resolvers/ai/ai-usage-item.d.ts

@@ -0,0 +1,70 @@
+export declare const shapeName = "TSAiUsageItem";
+/**
+ * Schema for AI usage item tracking token consumption by service and model.
+ * Matches the AiUsageItem type from @takeshape/util.
+ */
+export declare const schema: {
+    readonly title: "TSAiUsageItem";
+    readonly type: "object";
+    readonly description: "Token usage breakdown for a single service and model";
+    readonly properties: {
+        readonly service: {
+            readonly type: "string";
+            readonly description: "The AI service provider (e.g., \"openai\", \"anthropic\")";
+        };
+        readonly model: {
+            readonly type: "string";
+            readonly description: "The model identifier (e.g., \"gpt-4\", \"claude-3-opus\")";
+        };
+        readonly inputTokens: {
+            readonly type: "number";
+            readonly description: "Number of input/prompt tokens consumed";
+        };
+        readonly outputTokens: {
+            readonly type: "number";
+            readonly description: "Number of output/completion tokens generated";
+        };
+        readonly totalTokens: {
+            readonly type: "number";
+            readonly description: "Total tokens (input + output)";
+        };
+        readonly inputTokenDetails: {
+            readonly type: "object";
+            readonly description: "Detailed breakdown of input token usage";
+            readonly properties: {
+                readonly noCacheTokens: {
+                    readonly type: "number";
+                    readonly description: "Tokens not using cache";
+                };
+                readonly cacheReadTokens: {
+                    readonly type: "number";
+                    readonly description: "Tokens served from cache";
+                };
+                readonly cacheWriteTokens: {
+                    readonly type: "number";
+                    readonly description: "Tokens written to cache";
+                };
+            };
+        };
+        readonly outputTokenDetails: {
+            readonly type: "object";
+            readonly description: "Detailed breakdown of output token usage";
+            readonly properties: {
+                readonly textTokens: {
+                    readonly type: "number";
+                    readonly description: "Regular text output tokens";
+                };
+                readonly reasoningTokens: {
+                    readonly type: "number";
+                    readonly description: "Extended thinking tokens";
+                };
+            };
+        };
+        readonly guardrailUnits: {
+            readonly type: "number";
+            readonly description: "Number of guardrail units consumed";
+        };
+    };
+    readonly required: ["service", "model"];
+    readonly additionalProperties: false;
+};

package/dist/resolvers/ai/ai-usage-item.js

@@ -0,0 +1,70 @@
+export const shapeName = 'TSAiUsageItem';
+/**
+ * Schema for AI usage item tracking token consumption by service and model.
+ * Matches the AiUsageItem type from @takeshape/util.
+ */
+export const schema = {
+    title: shapeName,
+    type: 'object',
+    description: 'Token usage breakdown for a single service and model',
+    properties: {
+        service: {
+            type: 'string',
+            description: 'The AI service provider (e.g., "openai", "anthropic")'
+        },
+        model: {
+            type: 'string',
+            description: 'The model identifier (e.g., "gpt-4", "claude-3-opus")'
+        },
+        inputTokens: {
+            type: 'number',
+            description: 'Number of input/prompt tokens consumed'
+        },
+        outputTokens: {
+            type: 'number',
+            description: 'Number of output/completion tokens generated'
+        },
+        totalTokens: {
+            type: 'number',
+            description: 'Total tokens (input + output)'
+        },
+        inputTokenDetails: {
+            type: 'object',
+            description: 'Detailed breakdown of input token usage',
+            properties: {
+                noCacheTokens: {
+                    type: 'number',
+                    description: 'Tokens not using cache'
+                },
+                cacheReadTokens: {
+                    type: 'number',
+                    description: 'Tokens served from cache'
+                },
+                cacheWriteTokens: {
+                    type: 'number',
+                    description: 'Tokens written to cache'
+                }
+            }
+        },
+        outputTokenDetails: {
+            type: 'object',
+            description: 'Detailed breakdown of output token usage',
+            properties: {
+                textTokens: {
+                    type: 'number',
+                    description: 'Regular text output tokens'
+                },
+                reasoningTokens: {
+                    type: 'number',
+                    description: 'Extended thinking tokens'
+                }
+            }
+        },
+        guardrailUnits: {
+            type: 'number',
+            description: 'Number of guardrail units consumed'
+        }
+    },
+    required: ['service', 'model'],
+    additionalProperties: false
+};

package/dist/resolvers/ai/create-agent-session-response.d.ts

@@ -0,0 +1,276 @@
+import type { FromSchema } from 'json-schema-to-ts';
+export declare const schema: {
+    readonly properties: {
+        readonly id: {
+            readonly type: "string";
+            readonly description: "The unique identifier for the agent session.";
+        };
+        readonly createdAt: {
+            readonly type: "string";
+            readonly description: "ISO8601 timestamp when the agent session was created";
+            readonly format: "date-time";
+        };
+        readonly updatedAt: {
+            readonly type: "string";
+            readonly description: "ISO8601 timestamp when the agent session was updated";
+            readonly format: "date-time";
+        };
+        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 schemaHash: {
+            readonly type: "string";
+            readonly description: "The hash of the schema version associated with the agent session.";
+        };
+        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 hasAgentHistory: {
+            readonly type: "boolean";
+            readonly description: "Indicates whether the agent session has an associated history of agent responses.";
+        };
+        readonly hasFeedback: {
+            readonly type: "boolean";
+            readonly description: "Indicates whether the agent session has any messages with feedback.";
+        };
+        readonly suspend: {
+            readonly type: "boolean";
+            readonly description: "Indicates whether the agent session is suspended.";
+        };
+        readonly suspendedTransitionIndices: {
+            readonly type: "array";
+            readonly description: "An array of indices of suspended transitions in the agent session.";
+            readonly items: {
+                readonly type: "integer";
+            };
+        };
+        readonly firstMessageInput: {
+            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 lastMessageOutput: {
+            readonly title: "TSAgentMessageOutput";
+            readonly description: "The output schema for agent messages.";
+            readonly discriminator: {
+                readonly propertyName: "type";
+            };
+            readonly oneOf: [{
+                readonly title: "TSAgentGenerateStateOutput";
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "generate";
+                    };
+                    readonly data: {};
+                };
+                readonly required: ["type", "data"];
+                readonly additionalProperties: false;
+            }, {
+                readonly title: "TSAgentGraphQLStateOutput";
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "graphql";
+                    };
+                    readonly data: {};
+                };
+                readonly required: ["type", "data"];
+                readonly additionalProperties: false;
+            }, {
+                readonly title: "TSAgentChatStateOutput";
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "chat";
+                    };
+                    readonly data: {
+                        readonly type: "object";
+                        readonly properties: {
+                            readonly content: {
+                                readonly type: "string";
+                            };
+                            readonly artifact: {
+                                readonly type: "object";
+                            };
+                            readonly references: {
+                                readonly type: "array";
+                                readonly items: {
+                                    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;
+            }, {
+                readonly title: "TSAgentUnknownStateOutput";
+                readonly type: "object";
+                readonly properties: {
+                    readonly type: {
+                        readonly const: "unknown";
+                    };
+                    readonly data: {};
+                };
+                readonly required: ["type", "data"];
+                readonly additionalProperties: false;
+            }];
+        };
+        readonly totalTokens: {
+            readonly type: "number";
+            readonly description: "The total number of tokens used in the agent session.";
+        };
+        readonly domain: {
+            readonly type: "string";
+            readonly description: "The domain from which the agent session was created (e.g., \"shop.example.com\", \"app.takeshape.io\").";
+        };
+        readonly takeshapeUserId: {
+            readonly type: "string";
+            readonly description: "The TakeShape user ID if the session was created by a TakeShape user (via JWT or PAT).";
+        };
+        readonly usage: {
+            readonly type: "array";
+            readonly description: "Itemized token usage breakdown by service and model across all messages";
+            readonly items: {
+                readonly title: "TSAiUsageItem";
+                readonly type: "object";
+                readonly description: "Token usage breakdown for a single service and model";
+                readonly properties: {
+                    readonly service: {
+                        readonly type: "string";
+                        readonly description: "The AI service provider (e.g., \"openai\", \"anthropic\")";
+                    };
+                    readonly model: {
+                        readonly type: "string";
+                        readonly description: "The model identifier (e.g., \"gpt-4\", \"claude-3-opus\")";
+                    };
+                    readonly inputTokens: {
+                        readonly type: "number";
+                        readonly description: "Number of input/prompt tokens consumed";
+                    };
+                    readonly outputTokens: {
+                        readonly type: "number";
+                        readonly description: "Number of output/completion tokens generated";
+                    };
+                    readonly totalTokens: {
+                        readonly type: "number";
+                        readonly description: "Total tokens (input + output)";
+                    };
+                    readonly inputTokenDetails: {
+                        readonly type: "object";
+                        readonly description: "Detailed breakdown of input token usage";
+                        readonly properties: {
+                            readonly noCacheTokens: {
+                                readonly type: "number";
+                                readonly description: "Tokens not using cache";
+                            };
+                            readonly cacheReadTokens: {
+                                readonly type: "number";
+                                readonly description: "Tokens served from cache";
+                            };
+                            readonly cacheWriteTokens: {
+                                readonly type: "number";
+                                readonly description: "Tokens written to cache";
+                            };
+                        };
+                    };
+                    readonly outputTokenDetails: {
+                        readonly type: "object";
+                        readonly description: "Detailed breakdown of output token usage";
+                        readonly properties: {
+                            readonly textTokens: {
+                                readonly type: "number";
+                                readonly description: "Regular text output tokens";
+                            };
+                            readonly reasoningTokens: {
+                                readonly type: "number";
+                                readonly description: "Extended thinking tokens";
+                            };
+                        };
+                    };
+                    readonly guardrailUnits: {
+                        readonly type: "number";
+                        readonly description: "Number of guardrail units consumed";
+                    };
+                };
+                readonly required: ["service", "model"];
+                readonly additionalProperties: false;
+            };
+        };
+    };
+    readonly required: ["id", "agentName", "createdAt", "updatedAt", "done", "currentStateId", "chatSessionIds", "sessionMemory", "hasAgentHistory", "hasFeedback", "suspend", "projectId", "schemaId", "schemaHash", "totalTokens"];
+    readonly additionalProperties: false;
+    readonly title: "TSAgentSession";
+    readonly type: "object";
+};
+export type CreateAgentSessionResponse = FromSchema<typeof schema>;
+export declare function createUserShapeSchema(): {
+    '@ref': string;
+};

package/dist/resolvers/ai/create-agent-session-response.js

@@ -0,0 +1,9 @@
+import * as agentSessionPayload from "./agent-session-payload.js";
+export const schema = {
+    ...agentSessionPayload.schema
+};
+export function createUserShapeSchema() {
+    return {
+        '@ref': agentSessionPayload.shapeName
+    };
+}