From ff7df8648c75c5cf3c3e8b8fb0082a72ea9fbc59 Mon Sep 17 00:00:00 2001 From: EmersonBraun Date: Sat, 3 Oct 2026 15:45:04 -0300 Subject: [PATCH] docs(integrations): document testing API --- .changeset/bright-testing-docs-integrations.md | 5 +++++ docs/stability/jsdoc-coverage-v1.json | 6 +----- packages/integrations/src/testing/validate.ts | 10 ++++++++++ 3 files changed, 16 insertions(+), 5 deletions(-) create mode 100644 .changeset/bright-testing-docs-integrations.md diff --git a/.changeset/bright-testing-docs-integrations.md b/.changeset/bright-testing-docs-integrations.md new file mode 100644 index 000000000..49a927239 --- /dev/null +++ b/.changeset/bright-testing-docs-integrations.md @@ -0,0 +1,5 @@ +--- +"@agentskit/integrations": patch +--- + +Document the public API. diff --git a/docs/stability/jsdoc-coverage-v1.json b/docs/stability/jsdoc-coverage-v1.json index 50ca6d4df..ae6382b37 100644 --- a/docs/stability/jsdoc-coverage-v1.json +++ b/docs/stability/jsdoc-coverage-v1.json @@ -547,7 +547,6 @@ ".::ToolCallStatus", ".::ToolDefinition", ".::ToolExecutionContext", - ".::useChat", ".::UseStreamOptions", ".::UseStreamReturn" ], @@ -635,9 +634,7 @@ ".::WebhookInput", ".::WebhookSecretAuthSpec", ".::whatsappIntegration", - ".::whisperIntegration", - "./testing::validateAction", - "./testing::validateTrigger" + ".::whisperIntegration" ], "@agentskit/mcp": [ ".::AgentsKitMcpServerOptions", @@ -1098,7 +1095,6 @@ "@agentskit/svelte": [ ".::ChatContainer", ".::CodeBlock", - ".::createChatStore", ".::InputBar", ".::Markdown", ".::Message", diff --git a/packages/integrations/src/testing/validate.ts b/packages/integrations/src/testing/validate.ts index 1558bbeb4..34b33f5ba 100644 --- a/packages/integrations/src/testing/validate.ts +++ b/packages/integrations/src/testing/validate.ts @@ -21,6 +21,11 @@ function isObjectSchema(schema: JSONSchema7 | undefined): boolean { return !!schema && schema.type === 'object' } +/** Checks an action descriptor and returns every shape problem found. + * @param action Action descriptor to inspect. + * @param path Dotted path used as the problem location prefix. + * @returns Problems found, or an empty array when the action is valid. + */ export function validateAction(action: IntegrationAction, path: string): ValidationProblem[] { const problems: ValidationProblem[] = [] if (!ACTION_NAME_RE.test(action.name)) { @@ -38,6 +43,11 @@ export function validateAction(action: IntegrationAction, path: string): Validat return problems } +/** Checks a trigger descriptor and returns every shape problem found. + * @param trigger Trigger descriptor to inspect. + * @param path Dotted path used as the problem location prefix. + * @returns Problems found, or an empty array when the trigger is valid. + */ export function validateTrigger(trigger: IntegrationTrigger, path: string): ValidationProblem[] { const problems: ValidationProblem[] = [] if (!trigger.name?.trim()) {