From bb859f639200d6c05b74209caae0f884138c6a96 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 11 Oct 2026 05:41:58 +0000 Subject: [PATCH] docs(api): regenerate the API reference Generated from the latest versions on npm: - @probitas-test/builder 0.5.4 - @probitas-test/client 0.6.1 - @probitas-test/client-connectrpc 0.7.2 - @probitas-test/client-graphql 0.7.1 - @probitas-test/client-grpc 0.6.2 - @probitas-test/client-http 0.8.1 - @probitas-test/client-mongodb 0.6.2 - @probitas-test/client-rabbitmq 0.5.2 - @probitas-test/client-redis 0.5.2 - @probitas-test/client-sql 0.5.2 - @probitas-test/client-sql-duckdb 0.5.2 - @probitas-test/client-sql-mysql 0.5.2 - @probitas-test/client-sql-postgres 0.5.2 - @probitas-test/client-sql-sqlite 0.6.1 - @probitas-test/client-sqs 0.6.1 - @probitas-test/core 0.3.4 - @probitas-test/discover 0.4.2 - @probitas-test/expect 0.5.1 - @probitas-test/probitas 2.0.3 - @probitas-test/reporter 0.7.3 - @probitas-test/runner 0.5.8 --- data/api/index.json | 2 +- data/api/probitas.json | 18 +++++++++++++----- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/data/api/index.json b/data/api/index.json index 2ed6254..8329d81 100644 --- a/data/api/index.json +++ b/data/api/index.json @@ -255,7 +255,7 @@ { "name": "probitas", "specifier": "@probitas-test/probitas", - "version": "2.0.2", + "version": "2.0.3", "exportCount": 56, "counts": { "classes": 6, diff --git a/data/api/probitas.json b/data/api/probitas.json index aef59a3..5b533e4 100644 --- a/data/api/probitas.json +++ b/data/api/probitas.json @@ -9,15 +9,23 @@ "summary": [ { "kind": "text", - "text": "Probitas - Scenario-based testing and workflow execution framework.\n\nThis is the main entry point for the Probitas framework. It provides a fluent API\nfor building and executing scenario-based tests with support for:\n\n- **Sequential steps**: Define test steps that execute in order with type-safe context passing\n- **Skip conditions**: Conditionally skip steps or entire scenarios\n- **Rich assertions**: Built-in expect utilities for comprehensive assertions\n- **External clients**: Pre-configured clients for HTTP, databases, message queues, and more\n- **Test utilities**: Faker for test data, time mocking, and function spies\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas)\n- [Documentation](" + "text": "Probitas - Scenario-based testing and workflow execution framework.\n\nThis is the main entry point for the Probitas framework. It provides a fluent API\nfor building and executing scenario-based tests with support for:\n\n- **Sequential steps**: Define test steps that execute in order with type-safe context passing\n- **Skip conditions**: Conditionally skip steps or entire scenarios\n- **Rich assertions**: Built-in expect utilities for comprehensive assertions\n- **External clients**: Pre-configured clients for HTTP, databases, message queues, and more\n- **Test utilities**: Faker for test data, time mocking, and function spies\n\n## Links\n\n- [GitHub Repository](https://github.com/probitas-test/probitas)\n- [Documentation](https://probitas-test.github.io/)\n\n## Installation\n\nScenarios run on the " }, { - "kind": "relative-link", - "text": "./.claude/README.md" + "kind": "code", + "text": "`probitas`" + }, + { + "kind": "text", + "text": " CLI, a single binary (see the\ndocumentation). Install this package for editor support and type checking:\n\n" + }, + { + "kind": "code", + "text": "```bash\nnpm install --save-dev @probitas-test/probitas\n```" }, { "kind": "text", - "text": ")\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [@probitas/builder](https://jsr.io/@probitas/builder) | Fluent API for building scenario definitions |\n| [@probitas/runner](https://jsr.io/@probitas/runner) | Test execution engine with retry and concurrency |\n| [@probitas/core](https://jsr.io/@probitas/core) | Core type definitions and utilities |\n| [@probitas/discover](https://jsr.io/@probitas/discover) | Scenario file discovery |\n| [@probitas/logger](https://jsr.io/@probitas/logger) | Unified logging interface |\n| [@probitas/cli](https://jsr.io/@probitas/cli) | Command-line interface |\n\n## Core Exports\n\n- " + "text": "\n\n## Related Packages\n\n| Package | Description |\n|---------|-------------|\n| [@probitas-test/builder](https://www.npmjs.com/package/@probitas-test/builder) | Fluent API for building scenario definitions |\n| [@probitas-test/runner](https://www.npmjs.com/package/@probitas-test/runner) | Test execution engine with retry and concurrency |\n| [@probitas-test/core](https://www.npmjs.com/package/@probitas-test/core) | Core type definitions and utilities |\n| [@probitas-test/discover](https://www.npmjs.com/package/@probitas-test/discover) | Scenario file discovery |\n\n## Core Exports\n\n- " }, { "kind": "inline-tag", @@ -11615,5 +11623,5 @@ } ], "packageName": "@probitas-test/probitas", - "packageVersion": "2.0.2" + "packageVersion": "2.0.3" }