docs: in-process transport guide and API reference#34
Open
intech wants to merge 4 commits into
Open
Conversation
Migrate package manager from pnpm 10.23.0 to pnpm 11.0.4 (stable). Changes: - package.json: bump packageManager; remove pnpm field (pnpm 11 no longer reads it from package.json) - pnpm-workspace.yaml (new): move overrides (3 rules: lodash-es, rollup, minimatch) and replace onlyBuiltDependencies with allowBuilds map (esbuild) - pnpm-lock.yaml: regenerate under pnpm 11 (lockfileVersion 9.0 retained) Tested locally: - pnpm install: clean, no warnings - pnpm docs:build: VitePress build complete (109s, all API md files processed) Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Side-effect of running gen-api-docs.sh during pnpm 11 migration smoke tests. TypeDoc output normalized to current source state across all 13 @connectum/* packages. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Mirror the integrity-pinned packageManager value from connectum (PR #111) for consistency across the framework's repos. SHA512 hex digest sourced from npm registry metadata for the pnpm@11.0.4 tarball. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
- guide: en/guide/production/in-process-transport.md (rationale, usage, parity guarantees) - update: en/packages/core.md, en/packages/otel.md, en/guide/production/architecture.md - contributing: en/contributing/parity-invariant.md, en/contributing/parity-coverage.md - API reference regenerated via TypeDoc (covers new createLocalTransport, server.client, connectum.transport OTEL attribute, and new @connectum/test-fixtures package surface)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new in-process transport in
@connectum/coreand regenerates theTypeDoc-driven API reference to cover the added surface.
en/guide/production/in-process-transport.md— rationale, when to use it, registry-based auto-routing, parity guarantees, and the OTELconnectum.transportattribute.en/packages/core.md(new client/localClient/hasService APIs),en/packages/otel.md(new attribute / metric label).en/guide/production/architecture.mdupdated to show the in-process transport as a first-class peer of the HTTP/2 transport.en/contributing/parity-invariant.md(the structural-diff invariant the parity-gate CI workflow enforces) anden/contributing/parity-coverage.md(matrix of covered scenarios).en/api/— addscreateLocalTransport,LOCAL_TRANSPORT_HEADER/VALUE,ServerClientOptions,ATTR_CONNECTUM_TRANSPORT,detectConnectumTransport, the new@connectum/test-fixturespackage, and parity utilities under@connectum/testing.Test plan
pnpm docs:build— green (no dead links, sitemap generated)Related
Companion to the framework PR adding the in-process transport. The branch also contains the pnpm 11 migration commits.
🤖 Generated with Claude Code