t3-code-android-nightly/.repos/effect-smol/packages/tools/docgen/CHANGELOG.md
Julius Marminge 6f9cea00ae
chore(refs): sync Effect and Alchemy references to 4.0.1 and beta.80 (#16170)
Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-10-05 13:22:30 -07:00

97 KiB

@effect/docgen

4.0.1

Patch Changes

4.0.0

Patch Changes

  • #8633 2c552f2 Thanks @IMax153! - Effect 4.0 is the first stable release of Effect v4. It replaces the 4.0.0 beta and release-candidate series, whose per-release notes remain below under the 4.0.0-beta.* and 4.0.0-rc.* headings. To upgrade from Effect 3, follow the migration guide.

    Packaging and versioning

    • All Effect packages share one version number and are released together. Use the same version of effect and every @effect/* package.
    • @effect/platform, @effect/rpc, @effect/cluster, @effect/cli, @effect/ai, @effect/sql, @effect/workflow, @effect/experimental and similar packages are merged into effect. Separate packages remain only for platforms (@effect/platform-*), SQL drivers (@effect/sql-*), AI providers (@effect/ai-*), framework bindings (@effect/atom-*), OpenTelemetry, Vitest and tooling.
    • Modules such as effect/http, effect/http-api, effect/rpc, effect/cluster, effect/workflow, effect/ai, effect/cli, effect/sql and effect/schema import from effect/<area>. APIs tagged @stability unstable may have breaking changes in minor releases. APIs without a stability tag follow semver.
    • APIs that expose a third-party dependency are tagged @stability unstable, because that dependency's releases can change them. This covers NodeRedis, DenoRedis, BunRedis, @effect/platform-node/Undici and the undici dispatcher APIs, the ws options and re-exports in the platform packages, driver-specific options and clients in @effect/sql-clickhouse, @effect/sql-d1, @effect/sql-libsql, @effect/sql-mssql, @effect/sql-mysql2, @effect/sql-pglite and @effect/sql-sqlite-do, the provider clients, models and generated schemas in the @effect/ai-* packages, @effect/opentelemetry, and the vitest re-export in @effect/vitest.
    • effect has no runtime dependencies.
    • New packages in v4: @effect/platform-deno, @effect/sql-pglite, @effect/ai-openai-compat, @effect/ai-typesafe, @effect/atom-react, @effect/atom-solid, @effect/atom-vue, @effect/openapi-generator and @effect/doctest. @effect/docgen now lives in this repository.

    Core

    • The fiber runtime was rewritten for lower memory use and faster execution, with smaller bundles and better tree-shaking.
    • Services are defined with Context.Service, FiberRef is replaced by Context.Reference, Cause has a flat structure, and many combinators were renamed. See the migration guide for the full list.
    • Software transactional memory is built into Effect.tx, with TxRef, TxQueue, TxHashMap, TxPubSub, TxSemaphore and related Tx* data types.
    • Clock separates wall-clock time from monotonic time.
    • New modules include Semaphore, Latch, LayerRef, ErrorReporter, ByteSize, Newtype and Crypto. Arbitrary is now a native property-based testing module and no longer depends on fast-check.

    Schema

    • Schema v4 is a new implementation with faster parsing, class-based schemas, make constructors on every schema, and effectful decoding with services.
    • SchemaRepresentation powers JSON Schema (Draft-04, Draft-07, 2020-12 and OpenAPI 3.0/3.1) import and export, TypeScript code generation, and AI structured output.
    • SchemaBinary provides a compact binary codec and is the default wire format for cluster transports.
    • Optional JIT and AOT schema compilers are available as experimental modules.

    Platform, HTTP and RPC

    • HttpApi supports typed response headers, streaming and SSE responses, the HTTP QUERY method, HttpApiTest for in-memory testing, and much faster type checking for large APIs.
    • The HTTP modules add static file serving, response compression, rate-limited clients and graceful server shutdown.
    • Socket has a pull-based reader with backpressure and STARTTLS support. Network addresses are modeled by effect/net.
    • RPC serialization is schema-aware and supports server-originated requests and notifications.
    • @effect/platform-deno adds full Deno support. The Node, Bun, Deno and browser packages all provide the platform Crypto service, and the browser package adds IndexedDB support.

    Cluster and Workflow

    • Workflows can be declared with class syntax, and DurableQueue and an in-memory WorkflowEngine are available.
    • Runner memory can be bounded with ShardingConfig limits. Shutdown, entity movement and persisted replies are more reliable.

    SQL

    • @effect/sql-pg uses a built-in PostgreSQL client with pipelining, prepared statements and binary codecs, and no longer depends on pg.
    • @effect/sql-sqlite-node uses Node's built-in node:sqlite and requires Node 22.16 or newer.
    • SqlError exposes structured reasons such as UniqueViolation.

    AI

    • effect/ai adds EmbeddingModel, the DecisionModel classification and rating API, dynamic tools and tool approvals.
    • The MCP server supports protocol versions 2024-11-05 through 2026-07-28, including elicitation, sampling with tools, resource subscriptions and typed tool output.
    • Provider packages cover Anthropic, OpenAI, OpenAI-compatible APIs and OpenRouter.

    CLI, Atom, observability and testing

    • effect/cli adds global flags, command aliases and examples, an interactive wizard mode, and shell completions for Bash, Zsh and Fish.
    • effect/reactivity and the @effect/atom-* bindings add SSR hydration, stale-while-revalidate atoms and serializable RPC and HttpApi queries.
    • The OTLP exporters can be configured with standard OpenTelemetry environment variables, and @effect/opentelemetry aligns logs and spans with the OpenTelemetry specification.
    • @effect/vitest runs property tests with the native Arbitrary module and supports Vitest fixtures.

    Requirements

    • TypeScript 5.9 or newer. TypeScript 7 is recommended.
    • @effect/vitest and @effect/doctest require Vitest 5.
    • @effect/atom-react requires React 19.
    • @effect/platform-deno requires Deno 2.8.3 or newer.
  • Updated dependencies [cbfc7b4, 5a81a6f, 68b6394, 5250ca6, 5f9c9d1, 3278821, 83429b4, 0af6d0c, 927e01e, 10d8524, 35ac25a, 29e0aa7, 8783536, df77fff, ef7d77f, 035e369, f72790c, aa19472, 988c467, 735b77b, e5f7d12, 2c552f2]:

    • effect@4.0.0
    • @effect/platform-node@4.0.0

4.0.0-rc.118

Patch Changes

4.0.0-rc.117

Patch Changes

4.0.0-rc.116

Patch Changes

4.0.0-rc.115

Patch Changes

  • Updated dependencies [657254b, f9ef0e9, 4f73f9e]:
    • effect@4.0.0-rc.115
    • @effect/platform-node@4.0.0-rc.115

4.0.0-rc.114

Patch Changes

4.0.0-rc.113

Patch Changes

4.0.0-rc.112

Patch Changes

4.0.0-rc.111

Patch Changes

4.0.0-rc.110

Patch Changes

4.0.0-rc.109

Patch Changes

4.0.0-rc.108

Patch Changes

4.0.0-beta.107

Patch Changes

4.0.0-beta.106

Patch Changes

4.0.0-beta.105

Patch Changes

4.0.0-beta.104

Patch Changes

4.0.0-beta.103

Patch Changes

4.0.0-beta.102

Major Changes

  • #6556 19eeda6 Thanks @fubhy! - Migrate @effect/docgen into the Effect monorepo and update it to Effect 4 while retaining existing behavior.

Patch Changes

0.5.2

Patch Changes

  • 3b595aa: Remove duplicate logger

0.5.1

Patch Changes

  • 0b3b34e: Typecheck examples deeply nested within namespaces

0.5.0

Minor Changes

  • 8a0eb55: Support custom code fences when rendering examples

0.4.7

Patch Changes

  • e3ae139: Typecheck namespace examples

0.4.6

Patch Changes

  • fcd5649: Support examples enclosed in Extended Markdown code blocks

  • 95f136e: Support deeply nested namespaces.

    Previously, the docgen would fail with a [Markdown] Unsupported namespace nesting: 4 error. With this change all namespace headers at depth level 3 and above would be rendered using H4 elements.

0.4.5

Patch Changes

  • 8959440: Fixes the type checking and execution of examples on Windows

0.4.4

Patch Changes

  • 00ce7a0: upgrade ts-morph to 23.0.0
  • 5b888e5: srcDir and outDir fields in docgen.json are currently ignored. With this patch, they are taken into account

0.4.3

Patch Changes

  • 7add2b9: update dependencies

0.4.2

Patch Changes

  • 619a0e3: use @effect/markdown-toc instead of github dependency

0.4.1

Patch Changes

  • b9bfab0: add reporting of tsc and tsx errors, closes #66

0.4.0

Minor Changes

  • 5fbec18: update effect

Patch Changes

  • 08e8347: use ConfigProvider to load configuration for docgen

0.3.8

Patch Changes

  • 8abf24f: Core: do not swallow examples errors

0.3.7

Patch Changes

  • 2573662: update effect

0.3.6

Patch Changes

  • d58b355: chore: add defaults to schema.json

0.3.5

Patch Changes

  • bcaf971: fix glob pattern on windows

0.3.4

Patch Changes

  • 4e72aee: Re-added schema.json

0.3.3

Patch Changes

  • 3ee6dd1: Improve error output when spawning child process fails
  • 73a1d93: build with tsup

0.3.2

Patch Changes

  • 16fc976: Updated dependencies

0.3.1

Patch Changes

  • b799243: add --no-examples option

0.3.0

Minor Changes

  • e08edb1: Modernized and switched to a tsc and tsx based setup with support for NodeNext module resolution.

0.2.1

Patch Changes

  • 2677b9d: updated effect
  • 743ce06: change theme default

0.2.0

Minor Changes

  • ecd00a5: update effect and add effect/platform-node dependency

0.1.8

Patch Changes

  • 5411c71: Support for parsing "export * as namespace"

0.1.7

Patch Changes

  • b94de9f: add support for export * from ...

0.1.6

Patch Changes

  • 172ac81: Fix parsing regression caused by compilerOptions parsing

0.1.5

Patch Changes

  • 85301ea: Add support for resolving compilerOptions from tsconfig files

0.1.4

Patch Changes

  • 8be0092: add support for namespaces
  • 8be0092: BugFix: remove stale modules from /docs folder

0.1.3

Patch Changes

  • d8006f3: patch markdown-toc to prevent duplicate links
  • 514f73f: update to effect framework package

0.1.2

Patch Changes

  • 115b996: fix formatting of the _config.yml output by docgen
  • 115b996: upgrade dependencies

0.1.1

Patch Changes

  • 2a909a1: fix config handling

0.1.0

Minor Changes

  • eb5ef08: rename docs-ts.json to docgen.json

0.0.3

Patch Changes

  • d139f78: ignore internal classes

0.0.2

Patch Changes

  • 4e88501: fix shebang line

0.0.1

Patch Changes

  • 4faa066: add initial code