From 3e61557b9dc4e440b655edbbfd9dace1034642f7 Mon Sep 17 00:00:00 2001 From: intech Date: Mon, 22 Jun 2026 01:17:38 +0400 Subject: [PATCH 1/6] docs(api): regenerate API reference for 1.1.0 (stable /blob/main/ source links) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit TypeDoc against the current source. Adds the new 1.1.0 pages — createCatalogClient (+ CatalogClient / CreateCatalogClientOptions); createInternalAuthInterceptor, meshIdentityTrust, signedTokenTrust, sharedSecretTrust, getInternalMethods (+ their option/type pages); the @connectum/auth/testing RS256 helpers; and createBroadcastSubscribers (+ BroadcastReactor / BroadcastSubscribersOptions) — and updates EventBusOptions (now publishes + strictTopics). All source links are normalized to a stable /blob/main/... (connectum's docs:api post-process), so this is a one-time link stabilization with no spurious churn or file moves on future regens. Zero deletions (1.1.0 is additive). Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 --- .../auth/classes/AuthzDeniedError.md | 12 +- en/api/@connectum/auth/classes/LruCache.md | 12 +- .../auth/functions/createAuthInterceptor.md | 2 +- .../auth/functions/createAuthzInterceptor.md | 2 +- .../createClientBearerInterceptor.md | 2 +- .../createClientGatewayInterceptor.md | 2 +- .../functions/createGatewayAuthInterceptor.md | 2 +- .../createInternalAuthInterceptor.md | 73 +++++++++++ .../functions/createJwtAuthInterceptor.md | 2 +- .../functions/createProtoAuthzInterceptor.md | 31 +++-- .../functions/createSessionAuthInterceptor.md | 2 +- .../auth/functions/getAuthContext.md | 2 +- .../auth/functions/getInternalMethods.md | 47 +++++++ .../auth/functions/getPublicMethods.md | 2 +- .../auth/functions/matchesMethodPattern.md | 2 +- .../auth/functions/meshIdentityTrust.md | 34 +++++ .../auth/functions/parseAuthHeaders.md | 2 +- .../auth/functions/requireAuthContext.md | 2 +- .../auth/functions/resolveMethodAuth.md | 5 +- .../auth/functions/setAuthHeaders.md | 2 +- .../auth/functions/sharedSecretTrust.md | 31 +++++ .../auth/functions/signedTokenTrust.md | 41 ++++++ en/api/@connectum/auth/index.md | 12 ++ .../@connectum/auth/interfaces/AuthContext.md | 16 +-- .../auth/interfaces/AuthInterceptorOptions.md | 14 +- .../auth/interfaces/AuthzDeniedDetails.md | 8 +- .../interfaces/AuthzInterceptorOptions.md | 10 +- .../@connectum/auth/interfaces/AuthzRule.md | 10 +- .../auth/interfaces/CacheOptions.md | 6 +- .../ClientBearerInterceptorOptions.md | 4 +- .../ClientGatewayInterceptorOptions.md | 8 +- .../GatewayAuthInterceptorOptions.md | 14 +- .../auth/interfaces/GatewayHeaderMapping.md | 14 +- .../InternalAuthInterceptorOptions.md | 37 ++++++ .../interfaces/JwtAuthInterceptorOptions.md | 22 ++-- .../auth/interfaces/MeshIdentityEntry.md | 49 +++++++ .../interfaces/MeshIdentityTrustOptions.md | 51 ++++++++ .../ProtoAuthzInterceptorOptions.md | 8 +- .../auth/interfaces/ResolvedMethodAuth.md | 20 ++- .../SessionAuthInterceptorOptions.md | 16 +-- .../interfaces/SharedSecretTrustOptions.md | 89 +++++++++++++ .../auth/interfaces/SignedTokenIssuer.md | 85 +++++++++++++ .../interfaces/SignedTokenTrustOptions.md | 52 ++++++++ en/api/@connectum/auth/proto/index.md | 6 + .../auth/proto/type-aliases/MethodAuth.md | 15 +++ .../auth/proto/type-aliases/ServiceAuth.md | 15 ++- .../auth/proto/variables/MethodAuthSchema.md | 2 +- .../auth/proto/variables/ServiceAuthSchema.md | 2 +- .../auth/proto/variables/method_auth.md | 2 +- .../auth/proto/variables/service_auth.md | 2 +- .../functions/createMockAuthContext.md | 2 +- .../auth/testing/functions/createTestJwt.md | 2 +- .../testing/functions/createTestJwtRS256.md | 51 ++++++++ .../functions/generateRsaTestKeypair.md | 25 ++++ .../testing/functions/startTestJwksServer.md | 22 ++++ .../auth/testing/functions/withAuthContext.md | 2 +- en/api/@connectum/auth/testing/index.md | 9 ++ .../auth/testing/interfaces/RsaTestKeypair.md | 47 +++++++ .../auth/testing/interfaces/TestJwksServer.md | 41 ++++++ .../auth/testing/variables/TEST_JWT_KID.md | 9 ++ .../auth/testing/variables/TEST_JWT_SECRET.md | 2 +- .../auth/type-aliases/AuthzEffect.md | 2 +- .../auth/type-aliases/InterceptorFactory.md | 2 +- .../auth/type-aliases/InternalTrustSource.md | 34 +++++ .../@connectum/auth/variables/AUTH_HEADERS.md | 2 +- .../@connectum/auth/variables/AuthzEffect.md | 2 +- .../auth/variables/authContextStorage.md | 2 +- .../proto-sync/functions/executeProtoSync.md | 2 +- .../proto-sync/interfaces/ProtoSyncOptions.md | 10 +- .../proto-sync/variables/protoSyncCommand.md | 2 +- .../functions/fetchFileDescriptorSetBinary.md | 2 +- .../functions/fetchReflectionData.md | 2 +- .../reflection/interfaces/ReflectionResult.md | 8 +- .../core/classes/CatalogConfigError.md | 6 +- .../core/classes/TransportValidationError.md | 8 +- .../core/functions/collectStreamingMethods.md | 2 +- .../core/functions/createCatalogClient.md | 37 ++++++ .../core/functions/createLocalTransport.md | 2 +- .../@connectum/core/functions/createServer.md | 2 +- .../core/functions/defineCatalog.md | 2 +- .../core/functions/defineLazyService.md | 2 +- .../core/functions/defineService.md | 2 +- .../@connectum/core/functions/dnsResolver.md | 2 +- .../@connectum/core/functions/getTLSPath.md | 2 +- .../core/functions/isSanitizableError.md | 2 +- .../@connectum/core/functions/mapResolver.md | 2 +- .../core/functions/matchServicesPattern.md | 2 +- .../core/functions/mergeCatalogs.md | 2 +- .../core/functions/mergeEnabledServices.md | 2 +- .../core/functions/parseEnvConfig.md | 2 +- .../core/functions/parseServicesEnv.md | 2 +- .../core/functions/perServiceEnvResolver.md | 2 +- .../core/functions/readTLSCertificates.md | 2 +- .../functions/resolveEffectiveTransport.md | 2 +- .../core/functions/safeParseEnvConfig.md | 2 +- .../core/functions/singleTransportResolver.md | 2 +- en/api/@connectum/core/index.md | 5 + .../core/interfaces/BidiStreamHandle.md | 8 +- .../core/interfaces/CatalogClient.md | 40 ++++++ .../core/interfaces/ClientStreamHandle.md | 6 +- .../core/interfaces/ConnectumCallMap.md | 44 ++++++- .../core/interfaces/ConnectumStreamMap.md | 8 +- en/api/@connectum/core/interfaces/Context.md | 120 +++++++----------- .../interfaces/CreateCatalogClientOptions.md | 31 +++++ .../interfaces/CreateLocalTransportOptions.md | 4 +- .../core/interfaces/DnsResolverOptions.md | 6 +- .../PerServiceEnvResolverOptions.md | 4 +- .../core/interfaces/ResolverContext.md | 6 +- .../core/interfaces/SanitizableError.md | 6 +- .../core/interfaces/ServiceDefinition.md | 6 +- .../core/interfaces/StreamingMethodInfo.md | 8 +- .../core/type-aliases/CallOptions.md | 10 +- .../core/type-aliases/CatalogCall.md | 38 ++++++ .../core/type-aliases/CatalogStream.md | 29 +++++ .../core/type-aliases/ConnectumEnv.md | 2 +- .../core/type-aliases/ConnectumMethodImpl.md | 2 +- .../core/type-aliases/ConnectumServiceImpl.md | 2 +- .../core/type-aliases/EffectiveTransport.md | 2 +- .../core/type-aliases/RemoteResolver.md | 2 +- .../core/type-aliases/ServiceCatalog.md | 2 +- .../core/type-aliases/ServiceOptions.md | 2 +- .../core/type-aliases/StreamReturn.md | 2 +- .../type-aliases/TransportValidationMode.md | 2 +- .../types/interfaces/CreateServerOptions.md | 38 +++--- .../core/types/interfaces/EventBusLike.md | 6 +- .../core/types/interfaces/ProtocolContext.md | 4 +- .../types/interfaces/ProtocolRegistration.md | 8 +- .../core/types/interfaces/Server.md | 72 +++++------ .../types/interfaces/ServerClientOptions.md | 4 +- .../core/types/interfaces/ShutdownOptions.md | 10 +- .../core/types/interfaces/TLSOptions.md | 8 +- .../core/types/type-aliases/HttpHandler.md | 2 +- .../core/types/type-aliases/LifecycleEvent.md | 2 +- .../core/types/type-aliases/NodeRequest.md | 2 +- .../core/types/type-aliases/NodeResponse.md | 2 +- .../core/types/type-aliases/ServerState.md | 2 +- .../core/types/type-aliases/ShutdownHook.md | 2 +- .../types/type-aliases/TransportServer.md | 2 +- .../core/types/variables/LifecycleEvent.md | 2 +- .../core/types/variables/ServerState.md | 2 +- .../core/variables/BooleanFromStringSchema.md | 2 +- .../core/variables/ConnectumEnvSchema.md | 2 +- .../core/variables/EffectiveTransport.md | 2 +- .../core/variables/LogFormatSchema.md | 2 +- .../core/variables/LogLevelSchema.md | 2 +- .../core/variables/LoggerBackendSchema.md | 2 +- .../core/variables/NodeEnvSchema.md | 2 +- .../TRANSPORT_VALIDATION_ERROR_CODE.md | 2 +- .../core/variables/TransportValidationMode.md | 2 +- .../core/variables/defaultPropagateHeaders.md | 2 +- en/api/@connectum/core/variables/tlsPath.md | 2 +- .../events-amqp/classes/AmqpAdapterError.md | 4 +- .../classes/AmqpConnectionError.md | 4 +- .../classes/AmqpPublishNackError.md | 4 +- .../classes/AmqpPublishTimeoutError.md | 4 +- .../classes/AmqpSerializationError.md | 4 +- .../events-amqp/classes/AmqpTopologyError.md | 4 +- .../classes/AmqpUnroutableError.md | 6 +- .../events-amqp/functions/AmqpAdapter.md | 2 +- .../events-amqp/functions/toAmqpPattern.md | 2 +- .../types/interfaces/AmqpAdapterOptions.md | 32 ++--- .../interfaces/AmqpBindingDeclaration.md | 12 +- .../types/interfaces/AmqpConsumerOptions.md | 6 +- .../interfaces/AmqpExchangeDeclaration.md | 12 +- .../types/interfaces/AmqpExchangeOptions.md | 6 +- .../interfaces/AmqpLifecycleCallbacks.md | 10 +- .../types/interfaces/AmqpPublisherOptions.md | 8 +- .../types/interfaces/AmqpQueueDeclaration.md | 12 +- .../types/interfaces/AmqpQueueOptions.md | 12 +- .../types/interfaces/AmqpQueueOverride.md | 8 +- .../types/interfaces/AmqpRecoveryOptions.md | 12 +- .../interfaces/AmqpSerializationOptions.md | 8 +- .../types/interfaces/AmqpTopology.md | 8 +- .../types/type-aliases/AmqpTopologyMode.md | 2 +- .../types/variables/AmqpTopologyMode.md | 2 +- .../events-kafka/functions/KafkaAdapter.md | 2 +- .../types/interfaces/KafkaAdapterOptions.md | 12 +- .../events-nats/functions/NatsAdapter.md | 2 +- .../types/interfaces/NatsAdapterOptions.md | 10 +- .../types/interfaces/NatsConsumerOptions.md | 8 +- .../events-redis/functions/RedisAdapter.md | 2 +- .../types/interfaces/RedisAdapterOptions.md | 8 +- .../types/interfaces/RedisBrokerOptions.md | 8 +- .../events/classes/EventRouterImpl.md | 8 +- .../events/classes/NonRetryableError.md | 8 +- .../events/classes/RetryableError.md | 8 +- .../events/functions/MemoryAdapter.md | 2 +- .../events/functions/composeMiddleware.md | 2 +- .../functions/createBroadcastSubscribers.md | 40 ++++++ .../events/functions/createEventBus.md | 2 +- .../events/functions/createEventContext.md | 2 +- .../events/functions/deriveServiceName.md | 2 +- .../events/functions/dlqMiddleware.md | 2 +- .../events/functions/matchPattern.md | 2 +- .../events/functions/resolveTopicName.md | 2 +- .../events/functions/retryMiddleware.md | 2 +- en/api/@connectum/events/index.md | 6 + .../events/interfaces/BroadcastReactor.md | 37 ++++++ .../interfaces/BroadcastSubscribersOptions.md | 60 +++++++++ .../events/types/interfaces/AdapterContext.md | 4 +- .../events/types/interfaces/DlqOptions.md | 6 +- .../events/types/interfaces/EventAdapter.md | 12 +- .../events/types/interfaces/EventBus.md | 8 +- .../types/interfaces/EventBusOptions.md | 54 ++++++-- .../events/types/interfaces/EventContext.md | 18 +-- .../types/interfaces/EventContextInit.md | 10 +- .../types/interfaces/EventHandlerConfig.md | 6 +- .../types/interfaces/EventRouteEntry.md | 10 +- .../events/types/interfaces/EventRouter.md | 4 +- .../types/interfaces/EventSubscription.md | 4 +- .../types/interfaces/MiddlewareConfig.md | 8 +- .../events/types/interfaces/PublishOptions.md | 10 +- .../events/types/interfaces/RawEvent.md | 14 +- .../types/interfaces/RawSubscribeOptions.md | 4 +- .../events/types/interfaces/RetryOptions.md | 14 +- .../types/type-aliases/EventMiddleware.md | 2 +- .../types/type-aliases/EventMiddlewareNext.md | 2 +- .../events/types/type-aliases/EventRoute.md | 2 +- .../types/type-aliases/RawEventHandler.md | 2 +- .../type-aliases/ServiceEventHandlers.md | 2 +- .../types/type-aliases/TypedEventHandler.md | 2 +- .../healthcheck/classes/HealthcheckManager.md | 20 +-- .../healthcheck/functions/Healthcheck.md | 2 +- .../functions/createHealthcheckManager.md | 2 +- .../functions/createHttpHealthHandler.md | 2 +- .../functions/parseServiceFromUrl.md | 2 +- .../types/interfaces/HealthcheckOptions.md | 10 +- .../types/interfaces/ServiceStatus.md | 4 +- .../types/type-aliases/ServingStatus.md | 2 +- .../types/variables/ServingStatus.md | 2 +- .../variables/healthcheckManager.md | 2 +- .../functions/createBulkheadInterceptor.md | 2 +- .../createCircuitBreakerInterceptor.md | 2 +- .../functions/defaultFailurePredicate.md | 2 +- .../functions/createDefaultInterceptors.md | 2 +- .../interfaces/DefaultInterceptorOptions.md | 18 +-- .../createErrorHandlerInterceptor.md | 2 +- .../functions/createFallbackInterceptor.md | 2 +- .../interfaces/BulkheadOptions.md | 8 +- .../interfaces/CircuitBreakerOptions.md | 10 +- .../interfaces/ErrorHandlerOptions.md | 8 +- .../interfaces/FallbackOptions.md | 6 +- .../interceptors/interfaces/LoggerOptions.md | 8 +- .../interceptors/interfaces/RetryOptions.md | 12 +- .../interfaces/SerializerOptions.md | 8 +- .../interceptors/interfaces/TimeoutOptions.md | 6 +- .../functions/createLoggerInterceptor.md | 2 +- .../createMethodFilterInterceptor.md | 2 +- .../retry/functions/createRetryInterceptor.md | 2 +- .../functions/createSerializerInterceptor.md | 2 +- .../functions/createTimeoutInterceptor.md | 2 +- .../type-aliases/InterceptorFactory.md | 2 +- .../type-aliases/MethodFilterMap.md | 2 +- .../type-aliases/ConnectErrorCode.md | 2 +- .../variables/ATTR_CONNECTUM_TRANSPORT.md | 2 +- .../ATTR_CONNECTUM_TRANSPORT_METRIC.md | 2 +- .../attributes/variables/ATTR_ERROR_TYPE.md | 2 +- .../variables/ATTR_NETWORK_PEER_ADDRESS.md | 2 +- .../variables/ATTR_NETWORK_PEER_PORT.md | 2 +- .../variables/ATTR_NETWORK_PROTOCOL_NAME.md | 2 +- .../variables/ATTR_NETWORK_TRANSPORT.md | 2 +- .../ATTR_RPC_CONNECT_RPC_STATUS_CODE.md | 2 +- .../variables/ATTR_RPC_MESSAGE_ID.md | 2 +- .../variables/ATTR_RPC_MESSAGE_TYPE.md | 2 +- .../ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md | 2 +- .../attributes/variables/ATTR_RPC_METHOD.md | 2 +- .../attributes/variables/ATTR_RPC_SERVICE.md | 2 +- .../attributes/variables/ATTR_RPC_SYSTEM.md | 2 +- .../variables/ATTR_SERVER_ADDRESS.md | 2 +- .../attributes/variables/ATTR_SERVER_PORT.md | 2 +- .../CONNECTUM_INTERNAL_TRANSPORT_HEADER.md | 2 +- ...CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md | 2 +- .../attributes/variables/ConnectErrorCode.md | 2 +- .../variables/ConnectErrorCodeName.md | 2 +- .../attributes/variables/RPC_MESSAGE_EVENT.md | 2 +- .../variables/RPC_SYSTEM_CONNECT_RPC.md | 2 +- .../functions/createOtelClientInterceptor.md | 2 +- .../functions/getBatchSpanProcessorOptions.md | 2 +- .../otel/functions/getCollectorOptions.md | 2 +- .../otel/functions/getOTLPSettings.md | 2 +- .../otel/functions/getServiceMetadata.md | 2 +- .../functions/createOtelInterceptor.md | 2 +- .../interfaces/BatchSpanProcessorOptions.md | 10 +- .../otel/interfaces/CollectorOptions.md | 6 +- .../otel/interfaces/OTLPSettings.md | 8 +- .../otel/interfaces/OtelBaseOptions.md | 12 +- .../OtelClientInterceptorOptions.md | 16 +-- .../otel/interfaces/OtelInterceptorOptions.md | 18 +-- .../otel/interfaces/TraceAllOptions.md | 12 +- .../otel/interfaces/TracedOptions.md | 10 +- .../otel/logger/functions/getLogger.md | 2 +- .../otel/logger/interfaces/Logger.md | 12 +- .../otel/logger/interfaces/LoggerOptions.md | 4 +- .../otel/meter/functions/getMeter.md | 2 +- .../functions/createRpcClientMetrics.md | 2 +- .../functions/createRpcServerMetrics.md | 2 +- .../metrics/interfaces/RpcClientMetrics.md | 8 +- .../metrics/interfaces/RpcServerMetrics.md | 8 +- .../functions/buildResourceAttributes.md | 2 +- .../otel/provider/functions/getProvider.md | 2 +- .../otel/provider/functions/initProvider.md | 2 +- .../parseOtelResourceAttributesEnv.md | 2 +- .../provider/functions/shutdownProvider.md | 2 +- .../provider/interfaces/ProviderOptions.md | 12 +- .../interfaces/ResourceAttributeInputs.md | 12 +- .../shared/functions/applyAttributeFilter.md | 2 +- .../shared/functions/buildBaseAttributes.md | 2 +- .../shared/functions/buildErrorAttributes.md | 2 +- .../functions/detectConnectumTransport.md | 2 +- .../shared/functions/estimateMessageSize.md | 2 +- .../shared/functions/wrapAsyncIterable.md | 2 +- .../shared/interfaces/BaseAttributeParams.md | 10 +- .../otel/traceAll/functions/traceAll.md | 2 +- .../otel/traced/functions/traced.md | 2 +- .../otel/tracer/functions/getTracer.md | 2 +- .../otel/type-aliases/ArgsFilter.md | 2 +- .../otel/type-aliases/ExporterType.md | 2 +- .../otel/type-aliases/MethodArgsFilter.md | 2 +- .../otel/type-aliases/OtelAttributeFilter.md | 2 +- .../otel/type-aliases/OtelFilter.md | 2 +- .../@connectum/otel/variables/ExporterType.md | 2 +- .../reflection/functions/Reflection.md | 2 +- .../reflection/functions/collectFileProtos.md | 2 +- .../index/functions/assertConnectError.md | 2 +- .../index/functions/createFakeMethod.md | 2 +- .../index/functions/createFakeService.md | 2 +- .../index/functions/createMockDescField.md | 2 +- .../index/functions/createMockDescMessage.md | 2 +- .../index/functions/createMockDescMethod.md | 2 +- .../index/functions/createMockFn.md | 2 +- .../index/functions/createMockNext.md | 2 +- .../index/functions/createMockNextError.md | 2 +- .../index/functions/createMockNextSlow.md | 2 +- .../index/functions/createMockRequest.md | 2 +- .../index/functions/createMockStream.md | 2 +- .../index/interfaces/MockCall.md | 4 +- .../test-fixtures/index/interfaces/MockFn.md | 6 +- .../types/interfaces/FakeMethodOptions.md | 6 +- .../types/interfaces/FakeServiceOptions.md | 6 +- .../types/interfaces/MockDescFieldOptions.md | 8 +- .../interfaces/MockDescMessageOptions.md | 6 +- .../types/interfaces/MockDescMethodOptions.md | 10 +- .../types/interfaces/MockNextOptions.md | 6 +- .../types/interfaces/MockRequestOptions.md | 14 +- .../types/interfaces/MockStreamOptions.md | 4 +- .../index/classes/InMemoryMetricCollector.md | 16 +-- .../index/classes/InMemorySpanCollector.md | 14 +- .../index/functions/createLocalClient.md | 2 +- .../index/functions/createMockContext.md | 2 +- .../index/functions/createTestServer.md | 2 +- .../testing/index/functions/mockResolver.md | 2 +- .../testing/index/functions/mockService.md | 2 +- .../testing/index/functions/withTestServer.md | 2 +- .../interfaces/CreateMockContextOptions.md | 14 +- .../testing/index/interfaces/MockService.md | 6 +- .../index/interfaces/NormalizedMetric.md | 12 +- .../index/interfaces/NormalizedSpan.md | 18 +-- .../index/variables/MOCK_RESPONSE_HEADER.md | 2 +- .../variables/TRANSPORT_METRIC_ATTRIBUTE.md | 2 +- .../variables/TRANSPORT_SPAN_ATTRIBUTE.md | 2 +- .../interfaces/CreateTestServerOptions.md | 10 +- .../testing/types/interfaces/TestServer.md | 10 +- en/api/typedoc-sidebar.json | 2 +- 363 files changed, 2187 insertions(+), 933 deletions(-) create mode 100644 en/api/@connectum/auth/functions/createInternalAuthInterceptor.md create mode 100644 en/api/@connectum/auth/functions/getInternalMethods.md create mode 100644 en/api/@connectum/auth/functions/meshIdentityTrust.md create mode 100644 en/api/@connectum/auth/functions/sharedSecretTrust.md create mode 100644 en/api/@connectum/auth/functions/signedTokenTrust.md create mode 100644 en/api/@connectum/auth/interfaces/InternalAuthInterceptorOptions.md create mode 100644 en/api/@connectum/auth/interfaces/MeshIdentityEntry.md create mode 100644 en/api/@connectum/auth/interfaces/MeshIdentityTrustOptions.md create mode 100644 en/api/@connectum/auth/interfaces/SharedSecretTrustOptions.md create mode 100644 en/api/@connectum/auth/interfaces/SignedTokenIssuer.md create mode 100644 en/api/@connectum/auth/interfaces/SignedTokenTrustOptions.md create mode 100644 en/api/@connectum/auth/testing/functions/createTestJwtRS256.md create mode 100644 en/api/@connectum/auth/testing/functions/generateRsaTestKeypair.md create mode 100644 en/api/@connectum/auth/testing/functions/startTestJwksServer.md create mode 100644 en/api/@connectum/auth/testing/interfaces/RsaTestKeypair.md create mode 100644 en/api/@connectum/auth/testing/interfaces/TestJwksServer.md create mode 100644 en/api/@connectum/auth/testing/variables/TEST_JWT_KID.md create mode 100644 en/api/@connectum/auth/type-aliases/InternalTrustSource.md create mode 100644 en/api/@connectum/core/functions/createCatalogClient.md create mode 100644 en/api/@connectum/core/interfaces/CatalogClient.md create mode 100644 en/api/@connectum/core/interfaces/CreateCatalogClientOptions.md create mode 100644 en/api/@connectum/core/type-aliases/CatalogCall.md create mode 100644 en/api/@connectum/core/type-aliases/CatalogStream.md create mode 100644 en/api/@connectum/events/functions/createBroadcastSubscribers.md create mode 100644 en/api/@connectum/events/interfaces/BroadcastReactor.md create mode 100644 en/api/@connectum/events/interfaces/BroadcastSubscribersOptions.md diff --git a/en/api/@connectum/auth/classes/AuthzDeniedError.md b/en/api/@connectum/auth/classes/AuthzDeniedError.md index 394e3461..ea639c61 100644 --- a/en/api/@connectum/auth/classes/AuthzDeniedError.md +++ b/en/api/@connectum/auth/classes/AuthzDeniedError.md @@ -2,7 +2,7 @@ # Class: AuthzDeniedError -Defined in: [packages/auth/src/errors.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L26) +Defined in: [packages/auth/src/errors.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L26) Authorization denied error. @@ -23,7 +23,7 @@ exposing only "Access denied" to the client via SanitizableError protocol. > **new AuthzDeniedError**(`details`): `AuthzDeniedError` -Defined in: [packages/auth/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L39) +Defined in: [packages/auth/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L39) #### Parameters @@ -45,7 +45,7 @@ Defined in: [packages/auth/src/errors.ts:39](https://github.com/Connectum-Framew > `readonly` **authzDetails**: [`AuthzDeniedDetails`](../interfaces/AuthzDeniedDetails.md) -Defined in: [packages/auth/src/errors.ts:29](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L29) +Defined in: [packages/auth/src/errors.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L29) *** @@ -69,7 +69,7 @@ don't leak the underlying error, but instead make it available for logging. > `readonly` **clientMessage**: `"Access denied"` = `"Access denied"` -Defined in: [packages/auth/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L27) +Defined in: [packages/auth/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L27) #### Implementation of @@ -168,7 +168,7 @@ the message `[not found] hello`, and the rawMessage `hello`. > `readonly` **ruleName**: `string` -Defined in: [packages/auth/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L28) +Defined in: [packages/auth/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L28) *** @@ -212,7 +212,7 @@ not capture any frames. > **get** **serverDetails**(): `Readonly`\<`Record`\<`string`, `unknown`\>\> -Defined in: [packages/auth/src/errors.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L31) +Defined in: [packages/auth/src/errors.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L31) ##### Returns diff --git a/en/api/@connectum/auth/classes/LruCache.md b/en/api/@connectum/auth/classes/LruCache.md index 20db059c..f3be0ba6 100644 --- a/en/api/@connectum/auth/classes/LruCache.md +++ b/en/api/@connectum/auth/classes/LruCache.md @@ -2,7 +2,7 @@ # Class: LruCache\ -Defined in: [packages/auth/src/cache.ts:13](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/cache.ts#L13) +Defined in: [packages/auth/src/cache.ts:13](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/cache.ts#L13) ## Type Parameters @@ -16,7 +16,7 @@ Defined in: [packages/auth/src/cache.ts:13](https://github.com/Connectum-Framewo > **new LruCache**\<`T`\>(`options`): `LruCache`\<`T`\> -Defined in: [packages/auth/src/cache.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/cache.ts#L18) +Defined in: [packages/auth/src/cache.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/cache.ts#L18) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/auth/src/cache.ts:18](https://github.com/Connectum-Framewo > **get** **size**(): `number` -Defined in: [packages/auth/src/cache.ts:63](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/cache.ts#L63) +Defined in: [packages/auth/src/cache.ts:63](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/cache.ts#L63) ##### Returns @@ -54,7 +54,7 @@ Defined in: [packages/auth/src/cache.ts:63](https://github.com/Connectum-Framewo > **clear**(): `void` -Defined in: [packages/auth/src/cache.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/cache.ts#L59) +Defined in: [packages/auth/src/cache.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/cache.ts#L59) #### Returns @@ -66,7 +66,7 @@ Defined in: [packages/auth/src/cache.ts:59](https://github.com/Connectum-Framewo > **get**(`key`): `T` \| `undefined` -Defined in: [packages/auth/src/cache.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/cache.ts#L26) +Defined in: [packages/auth/src/cache.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/cache.ts#L26) #### Parameters @@ -84,7 +84,7 @@ Defined in: [packages/auth/src/cache.ts:26](https://github.com/Connectum-Framewo > **set**(`key`, `value`): `void` -Defined in: [packages/auth/src/cache.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/cache.ts#L41) +Defined in: [packages/auth/src/cache.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/cache.ts#L41) #### Parameters diff --git a/en/api/@connectum/auth/functions/createAuthInterceptor.md b/en/api/@connectum/auth/functions/createAuthInterceptor.md index 87431285..b3b30b0c 100644 --- a/en/api/@connectum/auth/functions/createAuthInterceptor.md +++ b/en/api/@connectum/auth/functions/createAuthInterceptor.md @@ -4,7 +4,7 @@ > **createAuthInterceptor**(`options`): `Interceptor` -Defined in: [packages/auth/src/auth-interceptor.ts:81](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/auth-interceptor.ts#L81) +Defined in: [packages/auth/src/auth-interceptor.ts:81](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/auth-interceptor.ts#L81) Create a generic authentication interceptor. diff --git a/en/api/@connectum/auth/functions/createAuthzInterceptor.md b/en/api/@connectum/auth/functions/createAuthzInterceptor.md index 2b35be50..876d54d1 100644 --- a/en/api/@connectum/auth/functions/createAuthzInterceptor.md +++ b/en/api/@connectum/auth/functions/createAuthzInterceptor.md @@ -4,7 +4,7 @@ > **createAuthzInterceptor**(`options?`): `Interceptor` -Defined in: [packages/auth/src/authz-interceptor.ts:85](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/authz-interceptor.ts#L85) +Defined in: [packages/auth/src/authz-interceptor.ts:85](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/authz-interceptor.ts#L85) Create an authorization interceptor. diff --git a/en/api/@connectum/auth/functions/createClientBearerInterceptor.md b/en/api/@connectum/auth/functions/createClientBearerInterceptor.md index 6e90eaf7..a52c6eb9 100644 --- a/en/api/@connectum/auth/functions/createClientBearerInterceptor.md +++ b/en/api/@connectum/auth/functions/createClientBearerInterceptor.md @@ -4,7 +4,7 @@ > **createClientBearerInterceptor**(`options`): `Interceptor` -Defined in: [packages/auth/src/client-bearer-interceptor.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/client-bearer-interceptor.ts#L51) +Defined in: [packages/auth/src/client-bearer-interceptor.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/client-bearer-interceptor.ts#L51) Create a client interceptor that attaches a Bearer token to outgoing requests. diff --git a/en/api/@connectum/auth/functions/createClientGatewayInterceptor.md b/en/api/@connectum/auth/functions/createClientGatewayInterceptor.md index a7b3f4b6..2e560948 100644 --- a/en/api/@connectum/auth/functions/createClientGatewayInterceptor.md +++ b/en/api/@connectum/auth/functions/createClientGatewayInterceptor.md @@ -4,7 +4,7 @@ > **createClientGatewayInterceptor**(`options`): `Interceptor` -Defined in: [packages/auth/src/client-gateway-interceptor.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/client-gateway-interceptor.ts#L52) +Defined in: [packages/auth/src/client-gateway-interceptor.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/client-gateway-interceptor.ts#L52) Create a client interceptor that attaches gateway auth headers to outgoing requests. diff --git a/en/api/@connectum/auth/functions/createGatewayAuthInterceptor.md b/en/api/@connectum/auth/functions/createGatewayAuthInterceptor.md index 81e04600..69e5363e 100644 --- a/en/api/@connectum/auth/functions/createGatewayAuthInterceptor.md +++ b/en/api/@connectum/auth/functions/createGatewayAuthInterceptor.md @@ -4,7 +4,7 @@ > **createGatewayAuthInterceptor**(`options`): `Interceptor` -Defined in: [packages/auth/src/gateway-auth-interceptor.ts:92](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/gateway-auth-interceptor.ts#L92) +Defined in: [packages/auth/src/gateway-auth-interceptor.ts:92](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/gateway-auth-interceptor.ts#L92) Create a gateway authentication interceptor. diff --git a/en/api/@connectum/auth/functions/createInternalAuthInterceptor.md b/en/api/@connectum/auth/functions/createInternalAuthInterceptor.md new file mode 100644 index 00000000..000b6ee3 --- /dev/null +++ b/en/api/@connectum/auth/functions/createInternalAuthInterceptor.md @@ -0,0 +1,73 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / createInternalAuthInterceptor + +# Function: createInternalAuthInterceptor() + +> **createInternalAuthInterceptor**(`options`): `Interceptor` + +Defined in: [packages/auth/src/internal-auth-interceptor.ts:89](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/internal-auth-interceptor.ts#L89) + +Create an internal (service-to-service) authentication interceptor. + +For methods matched by `internalMethods`, the configured `trustSource` +authorizes the call and sets an `AuthContext`. A trust source returning +`null` (or throwing) is rejected as `Code.Unauthenticated`. Non-internal +methods are a no-op pass-through. + +MUST run BEFORE `createProtoAuthzInterceptor`: the internal interceptor +populates the `AuthContext` that proto-authz's `internal` rule consumes. + +Each trust-source factory strips its own trust header after extraction on the +internal path (accept and reject), to prevent a spoofed marker from being +propagated downstream. NOTE: for NON-internal methods this interceptor is a +pure pass-through and does NOT strip any trust headers — a request to a +`public`/gated method carrying a forged identity header passes through +untouched. In the supported deployments the mesh sidecar (or an upstream +gateway) terminates the trust boundary and scrubs these headers on every +route; do not rely on this interceptor to sanitize non-internal routes. + +## Parameters + +### options + +[`InternalAuthInterceptorOptions`](../interfaces/InternalAuthInterceptorOptions.md) + +Internal auth configuration. + +## Returns + +`Interceptor` + +ConnectRPC interceptor. + +## Examples + +**Mesh deployment (production default)** + +```typescript +import { createInternalAuthInterceptor, meshIdentityTrust, getInternalMethods } from '@connectum/auth'; + +const internalAuth = createInternalAuthInterceptor({ + internalMethods: getInternalMethods(services), + trustSource: meshIdentityTrust({ + allowlist: [ + { principal: 'cluster.local/ns/default/sa/trips', roles: ['worker'] }, + ], + }), +}); +``` + +**Non-mesh, per-service signed tokens** + +```typescript +import { createInternalAuthInterceptor, signedTokenTrust, getInternalMethods } from '@connectum/auth'; + +const internalAuth = createInternalAuthInterceptor({ + internalMethods: getInternalMethods(services), + trustSource: signedTokenTrust({ + issuers: { + 'trips-service': { jwksUri: 'https://trips/.well-known/jwks.json', claimsMapping: { roles: 'roles' } }, + 'billing-service': { jwksUri: 'https://billing/.well-known/jwks.json' }, + }, + }), +}); +``` diff --git a/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md b/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md index 7301058e..e154ab93 100644 --- a/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md +++ b/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md @@ -4,7 +4,7 @@ > **createJwtAuthInterceptor**(`options`): `Interceptor` -Defined in: [packages/auth/src/jwt-auth-interceptor.ts:168](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/jwt-auth-interceptor.ts#L168) +Defined in: [packages/auth/src/jwt-auth-interceptor.ts:168](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/jwt-auth-interceptor.ts#L168) Create a JWT authentication interceptor. diff --git a/en/api/@connectum/auth/functions/createProtoAuthzInterceptor.md b/en/api/@connectum/auth/functions/createProtoAuthzInterceptor.md index 55b1e932..e715dab4 100644 --- a/en/api/@connectum/auth/functions/createProtoAuthzInterceptor.md +++ b/en/api/@connectum/auth/functions/createProtoAuthzInterceptor.md @@ -4,7 +4,7 @@ > **createProtoAuthzInterceptor**(`options?`): `Interceptor` -Defined in: [packages/auth/src/proto/proto-authz-interceptor.ts:125](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/proto-authz-interceptor.ts#L125) +Defined in: [packages/auth/src/proto/proto-authz-interceptor.ts:132](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/proto-authz-interceptor.ts#L132) Create a proto-based authorization interceptor. @@ -14,21 +14,28 @@ falls back to programmatic rules and an authorize callback. Authorization decision flow: ``` -1. resolveMethodAuth(req.method) -- read proto options -2. public = true --> skip (allow without authn) -3. Get auth context -- lazy: don't throw yet -4. requires defined, no context --> throw Unauthenticated -4b. requires defined, has context --> satisfiesRequirements? allow : deny -5. policy = "allow" --> allow -6. policy = "deny" --> deny -7. Evaluate programmatic rules -- unconditional rules work without context -8. Fallback: authorize callback --> requires auth context -9. Apply defaultPolicy --> deny without context = Unauthenticated +1. resolveMethodAuth(req.method) -- read proto options +2. public = true --> skip (allow without authn) +3. Get auth context -- lazy: don't throw yet +3b. internal = true: -- service-to-service (ADR-029) + no context --> throw Unauthenticated + no requires --> allow (any trusted internal caller) + has requires --> fall through to step 4 (inclusive roles) +4. requires defined, no context --> throw Unauthenticated +4b. requires defined, has context --> satisfiesRequirements? allow : deny +5. policy = "allow" --> allow +6. policy = "deny" --> deny +7. Evaluate programmatic rules -- unconditional rules work without context +8. Fallback: authorize callback --> requires auth context +9. Apply defaultPolicy --> deny without context = Unauthenticated ``` IMPORTANT: This interceptor MUST run AFTER an authentication interceptor in the chain (except for methods marked as `public` in proto options -or matched by unconditional programmatic rules). +or matched by unconditional programmatic rules). For `internal` methods the +upstream interceptor is [createInternalAuthInterceptor](createInternalAuthInterceptor.md); the chain order +is `errorHandler -> (jwtAuth | internalAuth) -> protoAuthz` — the auth +interceptors populate the `AuthContext` that this interceptor consumes. ## Parameters diff --git a/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md b/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md index 4b739fbf..89433dda 100644 --- a/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md +++ b/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md @@ -4,7 +4,7 @@ > **createSessionAuthInterceptor**(`options`): `Interceptor` -Defined in: [packages/auth/src/session-auth-interceptor.ts:60](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/session-auth-interceptor.ts#L60) +Defined in: [packages/auth/src/session-auth-interceptor.ts:60](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/session-auth-interceptor.ts#L60) Create a session-based authentication interceptor. diff --git a/en/api/@connectum/auth/functions/getAuthContext.md b/en/api/@connectum/auth/functions/getAuthContext.md index 24e72a12..26ae7c84 100644 --- a/en/api/@connectum/auth/functions/getAuthContext.md +++ b/en/api/@connectum/auth/functions/getAuthContext.md @@ -4,7 +4,7 @@ > **getAuthContext**(): [`AuthContext`](../interfaces/AuthContext.md) \| `undefined` -Defined in: [packages/auth/src/context.ts:111](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/context.ts#L111) +Defined in: [packages/auth/src/context.ts:111](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/context.ts#L111) Get the current auth context. diff --git a/en/api/@connectum/auth/functions/getInternalMethods.md b/en/api/@connectum/auth/functions/getInternalMethods.md new file mode 100644 index 00000000..3fc19971 --- /dev/null +++ b/en/api/@connectum/auth/functions/getInternalMethods.md @@ -0,0 +1,47 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / getInternalMethods + +# Function: getInternalMethods() + +> **getInternalMethods**(`services`): `string`[] + +Defined in: [packages/auth/src/proto/reader.ts:222](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L222) + +Get the list of internal method patterns from a set of service descriptors. + +Iterates over all methods in the given services, resolves their auth +configuration, and returns patterns for methods marked as `internal`. + +Mirrors [getPublicMethods](getPublicMethods.md). Internal methods skip end-user (JWT) +authentication — feed these into the JWT auth interceptor's `skipMethods` +exactly like public methods — but, unlike public methods, they still require +an internal trust marker established by [createInternalAuthInterceptor](createInternalAuthInterceptor.md). + +The returned patterns follow the `"service.typeName/method.name"` format +used by `skipMethods` in auth interceptors. + +## Parameters + +### services + +readonly `DescService`[] + +Service descriptors to scan + +## Returns + +`string`[] + +Array of method patterns in `"ServiceTypeName/MethodName"` format + +## Example + +```typescript +import { getInternalMethods, getPublicMethods } from '@connectum/auth/proto'; + +// JWT auth skips both public and internal methods; +// the internal interceptor then enforces the trust marker on internal ones. +const jwtAuth = createJwtAuthInterceptor({ + jwksUri: '...', + skipMethods: [...getPublicMethods(services), ...getInternalMethods(services)], +}); +``` diff --git a/en/api/@connectum/auth/functions/getPublicMethods.md b/en/api/@connectum/auth/functions/getPublicMethods.md index c8098831..b8c3c248 100644 --- a/en/api/@connectum/auth/functions/getPublicMethods.md +++ b/en/api/@connectum/auth/functions/getPublicMethods.md @@ -4,7 +4,7 @@ > **getPublicMethods**(`services`): `string`[] -Defined in: [packages/auth/src/proto/reader.ts:165](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/reader.ts#L165) +Defined in: [packages/auth/src/proto/reader.ts:178](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L178) Get the list of public method patterns from a set of service descriptors. diff --git a/en/api/@connectum/auth/functions/matchesMethodPattern.md b/en/api/@connectum/auth/functions/matchesMethodPattern.md index 328c233d..d1826fc0 100644 --- a/en/api/@connectum/auth/functions/matchesMethodPattern.md +++ b/en/api/@connectum/auth/functions/matchesMethodPattern.md @@ -4,7 +4,7 @@ > **matchesMethodPattern**(`serviceName`, `methodName`, `patterns`): `boolean` -Defined in: [packages/auth/src/method-match.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/method-match.ts#L23) +Defined in: [packages/auth/src/method-match.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/method-match.ts#L23) Check if a method matches any of the given patterns. diff --git a/en/api/@connectum/auth/functions/meshIdentityTrust.md b/en/api/@connectum/auth/functions/meshIdentityTrust.md new file mode 100644 index 00000000..ac7eeb8e --- /dev/null +++ b/en/api/@connectum/auth/functions/meshIdentityTrust.md @@ -0,0 +1,34 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / meshIdentityTrust + +# Function: meshIdentityTrust() + +> **meshIdentityTrust**(`options`): [`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +Defined in: [packages/auth/src/internal-auth-interceptor.ts:144](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/internal-auth-interceptor.ts#L144) + +Trust source that verifies a mesh-forwarded peer identity against an +allow-list (ADR-029 option (a) — production default, inherently per-service). + +In a service mesh the sidecar terminates mTLS and forwards the verified peer +identity as a header (e.g. an Istio short-form ServiceAccount principal +`cluster.local/ns//sa/`, or a SPIFFE id). The mesh issues each +workload its OWN mTLS identity, so matching that forwarded principal against +an allow-list is per-service by construction — compromising one workload +cannot forge another's identity. + +The identity header is stripped after extraction to prevent downstream +spoofing. + +## Parameters + +### options + +[`MeshIdentityTrustOptions`](../interfaces/MeshIdentityTrustOptions.md) + +Allow-list and the identity header name. + +## Returns + +[`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +An [InternalTrustSource](../type-aliases/InternalTrustSource.md). diff --git a/en/api/@connectum/auth/functions/parseAuthHeaders.md b/en/api/@connectum/auth/functions/parseAuthHeaders.md index 11b30aac..15aa3495 100644 --- a/en/api/@connectum/auth/functions/parseAuthHeaders.md +++ b/en/api/@connectum/auth/functions/parseAuthHeaders.md @@ -4,7 +4,7 @@ > **parseAuthHeaders**(`headers`): [`AuthContext`](../interfaces/AuthContext.md) \| `undefined` -Defined in: [packages/auth/src/headers.ts:92](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/headers.ts#L92) +Defined in: [packages/auth/src/headers.ts:92](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/headers.ts#L92) Parse AuthContext from request headers. diff --git a/en/api/@connectum/auth/functions/requireAuthContext.md b/en/api/@connectum/auth/functions/requireAuthContext.md index 0bf4703a..2d3e6204 100644 --- a/en/api/@connectum/auth/functions/requireAuthContext.md +++ b/en/api/@connectum/auth/functions/requireAuthContext.md @@ -4,7 +4,7 @@ > **requireAuthContext**(): [`AuthContext`](../interfaces/AuthContext.md) -Defined in: [packages/auth/src/context.ts:124](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/context.ts#L124) +Defined in: [packages/auth/src/context.ts:124](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/context.ts#L124) Get the current auth context or throw. diff --git a/en/api/@connectum/auth/functions/resolveMethodAuth.md b/en/api/@connectum/auth/functions/resolveMethodAuth.md index d4474258..76e2d690 100644 --- a/en/api/@connectum/auth/functions/resolveMethodAuth.md +++ b/en/api/@connectum/auth/functions/resolveMethodAuth.md @@ -4,7 +4,7 @@ > **resolveMethodAuth**(`method`): [`ResolvedMethodAuth`](../interfaces/ResolvedMethodAuth.md) -Defined in: [packages/auth/src/proto/reader.ts:65](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/reader.ts#L65) +Defined in: [packages/auth/src/proto/reader.ts:73](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L73) Resolve the effective authorization configuration for an RPC method. @@ -16,7 +16,8 @@ so 100% cache hit after the first call for each method). Priority (method overrides service): ``` -method.public -> service.public -> false +method.public -> service.public -> false +method.internal -> service.internal -> false method.requires -> service.default_requires -> undefined method.policy -> service.default_policy -> undefined ``` diff --git a/en/api/@connectum/auth/functions/setAuthHeaders.md b/en/api/@connectum/auth/functions/setAuthHeaders.md index 5e5e054c..f61e0c38 100644 --- a/en/api/@connectum/auth/functions/setAuthHeaders.md +++ b/en/api/@connectum/auth/functions/setAuthHeaders.md @@ -4,7 +4,7 @@ > **setAuthHeaders**(`headers`, `context`, `propagatedClaims?`): `void` -Defined in: [packages/auth/src/headers.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/headers.ts#L36) +Defined in: [packages/auth/src/headers.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/headers.ts#L36) Serialize AuthContext to request headers. diff --git a/en/api/@connectum/auth/functions/sharedSecretTrust.md b/en/api/@connectum/auth/functions/sharedSecretTrust.md new file mode 100644 index 00000000..d0a90577 --- /dev/null +++ b/en/api/@connectum/auth/functions/sharedSecretTrust.md @@ -0,0 +1,31 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / sharedSecretTrust + +# Function: sharedSecretTrust() + +> **sharedSecretTrust**(`options`): [`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +Defined in: [packages/auth/src/internal-auth-interceptor.ts:384](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/internal-auth-interceptor.ts#L384) + +Trust source that constant-time compares a single shared secret (ADR-029 +option (c)). + +**DEV-ONLY.** A single shared secret is NOT per-service: every legitimate +caller holds the same secret, so one compromise forges ALL internal +identities. Use [meshIdentityTrust](meshIdentityTrust.md) (mesh) or [signedTokenTrust](signedTokenTrust.md) +(non-mesh per-service JWT) in production. This factory exists only for local +development and single-tenant low-trust-boundary setups, and is labeled as +such so it is never mistaken for a containment-providing mode. + +## Parameters + +### options + +[`SharedSecretTrustOptions`](../interfaces/SharedSecretTrustOptions.md) + +The shared secret, header name, and the granted identity. + +## Returns + +[`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +An [InternalTrustSource](../type-aliases/InternalTrustSource.md). diff --git a/en/api/@connectum/auth/functions/signedTokenTrust.md b/en/api/@connectum/auth/functions/signedTokenTrust.md new file mode 100644 index 00000000..641f1e24 --- /dev/null +++ b/en/api/@connectum/auth/functions/signedTokenTrust.md @@ -0,0 +1,41 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / signedTokenTrust + +# Function: signedTokenTrust() + +> **signedTokenTrust**(`options`): [`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +Defined in: [packages/auth/src/internal-auth-interceptor.ts:266](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/internal-auth-interceptor.ts#L266) + +Trust source that verifies a per-service signed JWT via issuer-bound JWKS +(ADR-029 option (b) — non-mesh per-service containment, NOT a shared secret). + +Each caller signs a short-lived JWT with its OWN private key; this trust +source verifies it against that service's published public key (JWKS). +Compromising service A's key forges only A. + +**Hard security requirement — issuer-bound key selection (verified +empirically with `jose`).** The keyset is selected by the token's claimed +`iss` (`issuers[iss].jwksUri`), and `jose.jwtVerify` is pinned to that same +`issuer`. Each issuer gets its OWN `createRemoteJWKSet` — no `jwtVerify` call +ever receives a keyset containing more than one issuer's keys. A single shared +JWKS holding multiple services' keys does NOT contain compromise: `jose` +resolves the signing key by `kid` independently of the `iss` claim, so a token +claiming `iss: "B"` signed with A's key (header `kid: kid_A`) would be accepted +against a shared keyset. This per-issuer binding prevents that forge. + +The framework ships only the verification primitive; key issuance/rotation/ +JWKS publication belong to the deployment (SPIRE / the IdP / the mesh). + +## Parameters + +### options + +[`SignedTokenTrustOptions`](../interfaces/SignedTokenTrustOptions.md) + +Per-issuer JWKS configuration and the token header name. + +## Returns + +[`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +An [InternalTrustSource](../type-aliases/InternalTrustSource.md). diff --git a/en/api/@connectum/auth/index.md b/en/api/@connectum/auth/index.md index 60594900..2b769c37 100644 --- a/en/api/@connectum/auth/index.md +++ b/en/api/@connectum/auth/index.md @@ -24,15 +24,22 @@ - [ClientGatewayInterceptorOptions](interfaces/ClientGatewayInterceptorOptions.md) - [GatewayAuthInterceptorOptions](interfaces/GatewayAuthInterceptorOptions.md) - [GatewayHeaderMapping](interfaces/GatewayHeaderMapping.md) +- [InternalAuthInterceptorOptions](interfaces/InternalAuthInterceptorOptions.md) - [JwtAuthInterceptorOptions](interfaces/JwtAuthInterceptorOptions.md) +- [MeshIdentityEntry](interfaces/MeshIdentityEntry.md) +- [MeshIdentityTrustOptions](interfaces/MeshIdentityTrustOptions.md) - [ProtoAuthzInterceptorOptions](interfaces/ProtoAuthzInterceptorOptions.md) - [ResolvedMethodAuth](interfaces/ResolvedMethodAuth.md) - [SessionAuthInterceptorOptions](interfaces/SessionAuthInterceptorOptions.md) +- [SharedSecretTrustOptions](interfaces/SharedSecretTrustOptions.md) +- [SignedTokenIssuer](interfaces/SignedTokenIssuer.md) +- [SignedTokenTrustOptions](interfaces/SignedTokenTrustOptions.md) ## Type Aliases - [AuthzEffect](type-aliases/AuthzEffect.md) - [InterceptorFactory](type-aliases/InterceptorFactory.md) +- [InternalTrustSource](type-aliases/InternalTrustSource.md) ## Variables @@ -47,13 +54,18 @@ - [createClientBearerInterceptor](functions/createClientBearerInterceptor.md) - [createClientGatewayInterceptor](functions/createClientGatewayInterceptor.md) - [createGatewayAuthInterceptor](functions/createGatewayAuthInterceptor.md) +- [createInternalAuthInterceptor](functions/createInternalAuthInterceptor.md) - [createJwtAuthInterceptor](functions/createJwtAuthInterceptor.md) - [createProtoAuthzInterceptor](functions/createProtoAuthzInterceptor.md) - [createSessionAuthInterceptor](functions/createSessionAuthInterceptor.md) - [getAuthContext](functions/getAuthContext.md) +- [getInternalMethods](functions/getInternalMethods.md) - [getPublicMethods](functions/getPublicMethods.md) - [matchesMethodPattern](functions/matchesMethodPattern.md) +- [meshIdentityTrust](functions/meshIdentityTrust.md) - [parseAuthHeaders](functions/parseAuthHeaders.md) - [requireAuthContext](functions/requireAuthContext.md) - [resolveMethodAuth](functions/resolveMethodAuth.md) - [setAuthHeaders](functions/setAuthHeaders.md) +- [sharedSecretTrust](functions/sharedSecretTrust.md) +- [signedTokenTrust](functions/signedTokenTrust.md) diff --git a/en/api/@connectum/auth/interfaces/AuthContext.md b/en/api/@connectum/auth/interfaces/AuthContext.md index 297d65bd..2192c23c 100644 --- a/en/api/@connectum/auth/interfaces/AuthContext.md +++ b/en/api/@connectum/auth/interfaces/AuthContext.md @@ -2,7 +2,7 @@ # Interface: AuthContext -Defined in: [packages/auth/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L22) +Defined in: [packages/auth/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L22) Authenticated user context @@ -15,7 +15,7 @@ accessible via getAuthContext() in handlers and downstream interceptors. > `readonly` **claims**: `Readonly`\<`Record`\<`string`, `unknown`\>\> -Defined in: [packages/auth/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L32) +Defined in: [packages/auth/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L32) Raw claims from the credential (JWT claims, API key metadata, etc.) @@ -25,7 +25,7 @@ Raw claims from the credential (JWT claims, API key metadata, etc.) > `readonly` `optional` **expiresAt?**: `Date` -Defined in: [packages/auth/src/types.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L36) +Defined in: [packages/auth/src/types.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L36) Credential expiration time @@ -35,7 +35,7 @@ Credential expiration time > `readonly` `optional` **name?**: `string` -Defined in: [packages/auth/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L26) +Defined in: [packages/auth/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L26) Human-readable display name @@ -45,7 +45,7 @@ Human-readable display name > `readonly` **roles**: readonly `string`[] -Defined in: [packages/auth/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L28) +Defined in: [packages/auth/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L28) Assigned roles (e.g., ["admin", "user"]) @@ -55,7 +55,7 @@ Assigned roles (e.g., ["admin", "user"]) > `readonly` **scopes**: readonly `string`[] -Defined in: [packages/auth/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L30) +Defined in: [packages/auth/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L30) Granted scopes (e.g., ["read", "write"]) @@ -65,7 +65,7 @@ Granted scopes (e.g., ["read", "write"]) > `readonly` **subject**: `string` -Defined in: [packages/auth/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L24) +Defined in: [packages/auth/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L24) Authenticated subject identifier (user ID, service account, etc.) @@ -75,6 +75,6 @@ Authenticated subject identifier (user ID, service account, etc.) > `readonly` **type**: `string` -Defined in: [packages/auth/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L34) +Defined in: [packages/auth/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L34) Credential type identifier (e.g., "jwt", "api-key", "mtls") diff --git a/en/api/@connectum/auth/interfaces/AuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/AuthInterceptorOptions.md index 30f63869..db8a0076 100644 --- a/en/api/@connectum/auth/interfaces/AuthInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/AuthInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: AuthInterceptorOptions -Defined in: [packages/auth/src/types.ts:115](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L115) +Defined in: [packages/auth/src/types.ts:115](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L115) Generic auth interceptor options @@ -12,7 +12,7 @@ Generic auth interceptor options > `optional` **cache?**: [`CacheOptions`](CacheOptions.md) -Defined in: [packages/auth/src/types.ts:151](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L151) +Defined in: [packages/auth/src/types.ts:151](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L151) LRU cache for credentials verification results. Caches AuthContext by credential string to reduce verification overhead. @@ -23,7 +23,7 @@ Caches AuthContext by credential string to reduce verification overhead. > `optional` **extractCredentials?**: (`req`) => `string` \| `Promise`\<`string` \| `null`\> \| `null` -Defined in: [packages/auth/src/types.ts:123](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L123) +Defined in: [packages/auth/src/types.ts:123](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L123) Extract credentials from request. Default: extracts Bearer token from Authorization header. @@ -50,7 +50,7 @@ Credential string or null if no credentials found > `optional` **propagatedClaims?**: `string`[] -Defined in: [packages/auth/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L158) +Defined in: [packages/auth/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L158) Filter which claims are propagated in headers (SEC-001). When set, only listed claim keys are included in x-auth-claims header. @@ -62,7 +62,7 @@ When not set, all claims are propagated. > `optional` **propagateHeaders?**: `boolean` -Defined in: [packages/auth/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L145) +Defined in: [packages/auth/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L145) Propagate auth context as headers for downstream services. @@ -78,7 +78,7 @@ false > `optional` **skipMethods?**: `string`[] -Defined in: [packages/auth/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L139) +Defined in: [packages/auth/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L139) Methods to skip authentication for. Patterns: "Service/Method" or "Service/*" @@ -95,7 +95,7 @@ Patterns: "Service/Method" or "Service/*" > **verifyCredentials**: (`credentials`) => [`AuthContext`](AuthContext.md) \| `Promise`\<[`AuthContext`](AuthContext.md)\> -Defined in: [packages/auth/src/types.ts:132](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L132) +Defined in: [packages/auth/src/types.ts:132](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L132) Verify credentials and return auth context. REQUIRED. Must throw on invalid credentials. diff --git a/en/api/@connectum/auth/interfaces/AuthzDeniedDetails.md b/en/api/@connectum/auth/interfaces/AuthzDeniedDetails.md index 1bcf35e1..c3da5615 100644 --- a/en/api/@connectum/auth/interfaces/AuthzDeniedDetails.md +++ b/en/api/@connectum/auth/interfaces/AuthzDeniedDetails.md @@ -2,7 +2,7 @@ # Interface: AuthzDeniedDetails -Defined in: [packages/auth/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L14) +Defined in: [packages/auth/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L14) Details for authorization denied errors. @@ -12,7 +12,7 @@ Details for authorization denied errors. > `readonly` `optional` **requiredRoles?**: readonly `string`[] -Defined in: [packages/auth/src/errors.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L16) +Defined in: [packages/auth/src/errors.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L16) *** @@ -20,7 +20,7 @@ Defined in: [packages/auth/src/errors.ts:16](https://github.com/Connectum-Framew > `readonly` `optional` **requiredScopes?**: readonly `string`[] -Defined in: [packages/auth/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L17) +Defined in: [packages/auth/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L17) *** @@ -28,4 +28,4 @@ Defined in: [packages/auth/src/errors.ts:17](https://github.com/Connectum-Framew > `readonly` **ruleName**: `string` -Defined in: [packages/auth/src/errors.ts:15](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/errors.ts#L15) +Defined in: [packages/auth/src/errors.ts:15](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/errors.ts#L15) diff --git a/en/api/@connectum/auth/interfaces/AuthzInterceptorOptions.md b/en/api/@connectum/auth/interfaces/AuthzInterceptorOptions.md index 896fb1c2..0a6e3d0e 100644 --- a/en/api/@connectum/auth/interfaces/AuthzInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/AuthzInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: AuthzInterceptorOptions -Defined in: [packages/auth/src/types.ts:244](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L244) +Defined in: [packages/auth/src/types.ts:244](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L244) Authorization interceptor options @@ -12,7 +12,7 @@ Authorization interceptor options > `optional` **authorize?**: (`context`, `req`) => `boolean` \| `Promise`\<`boolean`\> -Defined in: [packages/auth/src/types.ts:266](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L266) +Defined in: [packages/auth/src/types.ts:266](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L266) Programmatic authorization callback. Called after rule evaluation if no rule matched, @@ -50,7 +50,7 @@ true if authorized, false otherwise > `optional` **defaultPolicy?**: [`AuthzEffect`](../type-aliases/AuthzEffect.md) -Defined in: [packages/auth/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L249) +Defined in: [packages/auth/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L249) Default policy when no rule matches. @@ -66,7 +66,7 @@ Default policy when no rule matches. > `optional` **rules?**: [`AuthzRule`](AuthzRule.md)[] -Defined in: [packages/auth/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L255) +Defined in: [packages/auth/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L255) Declarative authorization rules. Evaluated in order; first matching rule wins. @@ -77,7 +77,7 @@ Evaluated in order; first matching rule wins. > `optional` **skipMethods?**: `string`[] -Defined in: [packages/auth/src/types.ts:272](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L272) +Defined in: [packages/auth/src/types.ts:272](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L272) Methods to skip authorization for. diff --git a/en/api/@connectum/auth/interfaces/AuthzRule.md b/en/api/@connectum/auth/interfaces/AuthzRule.md index 1355c4a2..57e14e7b 100644 --- a/en/api/@connectum/auth/interfaces/AuthzRule.md +++ b/en/api/@connectum/auth/interfaces/AuthzRule.md @@ -2,7 +2,7 @@ # Interface: AuthzRule -Defined in: [packages/auth/src/types.ts:81](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L81) +Defined in: [packages/auth/src/types.ts:81](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L81) Authorization rule definition. @@ -16,7 +16,7 @@ When a rule has `requires`, the match semantics are: > `readonly` **effect**: [`AuthzEffect`](../type-aliases/AuthzEffect.md) -Defined in: [packages/auth/src/types.ts:87](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L87) +Defined in: [packages/auth/src/types.ts:87](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L87) Effect when rule matches @@ -26,7 +26,7 @@ Effect when rule matches > `readonly` **methods**: readonly `string`[] -Defined in: [packages/auth/src/types.ts:85](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L85) +Defined in: [packages/auth/src/types.ts:85](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L85) Method patterns to match (e.g., "admin.v1.AdminService/*", "user.v1.UserService/DeleteUser") @@ -36,7 +36,7 @@ Method patterns to match (e.g., "admin.v1.AdminService/*", "user.v1.UserService/ > `readonly` **name**: `string` -Defined in: [packages/auth/src/types.ts:83](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L83) +Defined in: [packages/auth/src/types.ts:83](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L83) Rule name for logging/debugging @@ -46,7 +46,7 @@ Rule name for logging/debugging > `readonly` `optional` **requires?**: `object` -Defined in: [packages/auth/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L94) +Defined in: [packages/auth/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L94) Required roles/scopes for this rule. diff --git a/en/api/@connectum/auth/interfaces/CacheOptions.md b/en/api/@connectum/auth/interfaces/CacheOptions.md index e48f3f35..13e54180 100644 --- a/en/api/@connectum/auth/interfaces/CacheOptions.md +++ b/en/api/@connectum/auth/interfaces/CacheOptions.md @@ -2,7 +2,7 @@ # Interface: CacheOptions -Defined in: [packages/auth/src/types.ts:105](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L105) +Defined in: [packages/auth/src/types.ts:105](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L105) LRU cache configuration for credentials verification @@ -12,7 +12,7 @@ LRU cache configuration for credentials verification > `readonly` `optional` **maxSize?**: `number` -Defined in: [packages/auth/src/types.ts:109](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L109) +Defined in: [packages/auth/src/types.ts:109](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L109) Maximum number of cached entries @@ -22,6 +22,6 @@ Maximum number of cached entries > `readonly` **ttl**: `number` -Defined in: [packages/auth/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L107) +Defined in: [packages/auth/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L107) Cache entry time-to-live in milliseconds diff --git a/en/api/@connectum/auth/interfaces/ClientBearerInterceptorOptions.md b/en/api/@connectum/auth/interfaces/ClientBearerInterceptorOptions.md index d4be6cff..b174c43b 100644 --- a/en/api/@connectum/auth/interfaces/ClientBearerInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/ClientBearerInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: ClientBearerInterceptorOptions -Defined in: [packages/auth/src/types.ts:367](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L367) +Defined in: [packages/auth/src/types.ts:524](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L524) Client-side Bearer token interceptor options. @@ -16,7 +16,7 @@ Client-side Bearer token interceptor options. > `readonly` **token**: `string` \| (() => `Promise`\<`string`\>) -Defined in: [packages/auth/src/types.ts:375](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L375) +Defined in: [packages/auth/src/types.ts:532](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L532) Bearer token value or async factory function. diff --git a/en/api/@connectum/auth/interfaces/ClientGatewayInterceptorOptions.md b/en/api/@connectum/auth/interfaces/ClientGatewayInterceptorOptions.md index 7cf5c904..98f5344d 100644 --- a/en/api/@connectum/auth/interfaces/ClientGatewayInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/ClientGatewayInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: ClientGatewayInterceptorOptions -Defined in: [packages/auth/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L383) +Defined in: [packages/auth/src/types.ts:540](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L540) Client-side gateway service-to-service auth interceptor options. @@ -16,7 +16,7 @@ Client-side gateway service-to-service auth interceptor options. > `readonly` `optional` **roles?**: `string`[] -Defined in: [packages/auth/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L389) +Defined in: [packages/auth/src/types.ts:546](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L546) Optional roles to propagate (JSON-encoded in header) @@ -26,7 +26,7 @@ Optional roles to propagate (JSON-encoded in header) > `readonly` **secret**: `string` -Defined in: [packages/auth/src/types.ts:385](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L385) +Defined in: [packages/auth/src/types.ts:542](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L542) Shared secret for gateway trust verification @@ -36,6 +36,6 @@ Shared secret for gateway trust verification > `readonly` **subject**: `string` -Defined in: [packages/auth/src/types.ts:387](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L387) +Defined in: [packages/auth/src/types.ts:544](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L544) Authenticated subject identifier (e.g., service name) diff --git a/en/api/@connectum/auth/interfaces/GatewayAuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/GatewayAuthInterceptorOptions.md index dbb3d841..2e6937d9 100644 --- a/en/api/@connectum/auth/interfaces/GatewayAuthInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/GatewayAuthInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: GatewayAuthInterceptorOptions -Defined in: [packages/auth/src/types.ts:301](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L301) +Defined in: [packages/auth/src/types.ts:301](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L301) Gateway auth interceptor options. @@ -15,7 +15,7 @@ Extracts auth context from gateway-injected headers. > `readonly` `optional` **defaultType?**: `string` -Defined in: [packages/auth/src/types.ts:318](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L318) +Defined in: [packages/auth/src/types.ts:318](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L318) Default credential type when not provided by gateway @@ -25,7 +25,7 @@ Default credential type when not provided by gateway > `readonly` **headerMapping**: [`GatewayHeaderMapping`](GatewayHeaderMapping.md) -Defined in: [packages/auth/src/types.ts:303](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L303) +Defined in: [packages/auth/src/types.ts:303](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L303) Mapping from AuthContext fields to gateway header names @@ -35,7 +35,7 @@ Mapping from AuthContext fields to gateway header names > `readonly` `optional` **propagateHeaders?**: `boolean` -Defined in: [packages/auth/src/types.ts:316](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L316) +Defined in: [packages/auth/src/types.ts:316](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L316) Propagate auth context as headers for downstream services @@ -45,7 +45,7 @@ Propagate auth context as headers for downstream services > `readonly` `optional` **skipMethods?**: `string`[] -Defined in: [packages/auth/src/types.ts:314](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L314) +Defined in: [packages/auth/src/types.ts:314](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L314) Methods to skip authentication for @@ -55,7 +55,7 @@ Methods to skip authentication for > `readonly` `optional` **stripHeaders?**: `string`[] -Defined in: [packages/auth/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L312) +Defined in: [packages/auth/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L312) Headers to strip from the request after extraction (prevent spoofing) @@ -65,7 +65,7 @@ Headers to strip from the request after extraction (prevent spoofing) > `readonly` **trustSource**: `object` -Defined in: [packages/auth/src/types.ts:305](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L305) +Defined in: [packages/auth/src/types.ts:305](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L305) Trust verification: check that request came from a trusted gateway diff --git a/en/api/@connectum/auth/interfaces/GatewayHeaderMapping.md b/en/api/@connectum/auth/interfaces/GatewayHeaderMapping.md index 5e3dfe97..d9619f83 100644 --- a/en/api/@connectum/auth/interfaces/GatewayHeaderMapping.md +++ b/en/api/@connectum/auth/interfaces/GatewayHeaderMapping.md @@ -2,7 +2,7 @@ # Interface: GatewayHeaderMapping -Defined in: [packages/auth/src/types.ts:280](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L280) +Defined in: [packages/auth/src/types.ts:280](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L280) Header name mapping for gateway auth context extraction. @@ -14,7 +14,7 @@ Maps AuthContext fields to custom header names used by the API gateway. > `readonly` `optional` **claims?**: `string` -Defined in: [packages/auth/src/types.ts:292](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L292) +Defined in: [packages/auth/src/types.ts:292](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L292) Header containing JSON-encoded claims @@ -24,7 +24,7 @@ Header containing JSON-encoded claims > `readonly` `optional` **name?**: `string` -Defined in: [packages/auth/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L284) +Defined in: [packages/auth/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L284) Header containing the display name @@ -34,7 +34,7 @@ Header containing the display name > `readonly` `optional` **roles?**: `string` -Defined in: [packages/auth/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L286) +Defined in: [packages/auth/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L286) Header containing JSON-encoded roles array @@ -44,7 +44,7 @@ Header containing JSON-encoded roles array > `readonly` `optional` **scopes?**: `string` -Defined in: [packages/auth/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L288) +Defined in: [packages/auth/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L288) Header containing space-separated scopes @@ -54,7 +54,7 @@ Header containing space-separated scopes > `readonly` **subject**: `string` -Defined in: [packages/auth/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L282) +Defined in: [packages/auth/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L282) Header containing the authenticated subject @@ -64,6 +64,6 @@ Header containing the authenticated subject > `readonly` `optional` **type?**: `string` -Defined in: [packages/auth/src/types.ts:290](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L290) +Defined in: [packages/auth/src/types.ts:290](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L290) Header containing credential type diff --git a/en/api/@connectum/auth/interfaces/InternalAuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/InternalAuthInterceptorOptions.md new file mode 100644 index 00000000..5a97752f --- /dev/null +++ b/en/api/@connectum/auth/interfaces/InternalAuthInterceptorOptions.md @@ -0,0 +1,37 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / InternalAuthInterceptorOptions + +# Interface: InternalAuthInterceptorOptions + +Defined in: [packages/auth/src/types.ts:341](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L341) + +Options for [createInternalAuthInterceptor](../functions/createInternalAuthInterceptor.md). + +## Properties + +### internalMethods + +> `readonly` **internalMethods**: readonly `string`[] + +Defined in: [packages/auth/src/types.ts:359](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L359) + +Method patterns that are internal (service-to-service). Typically the +output of `getInternalMethods(services)`. The interceptor enforces the +trust marker only on these methods; all other methods pass through +unchanged (no-op). + +Patterns: `"Service/Method"`, `"Service/*"`, or `"*"`. + +*** + +### trustSource + +> `readonly` **trustSource**: [`InternalTrustSource`](../type-aliases/InternalTrustSource.md) + +Defined in: [packages/auth/src/types.ts:350](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L350) + +The trust source that authorizes an internal call. + +Use one of the provided factories — [meshIdentityTrust](../functions/meshIdentityTrust.md) (production +default, per-service via the mesh), [signedTokenTrust](../functions/signedTokenTrust.md) (non-mesh, +per-service JWT/JWKS with mandatory issuer-bound key selection), or +[sharedSecretTrust](../functions/sharedSecretTrust.md) (dev-only fallback) — or supply a custom one. diff --git a/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md index d7a7bb77..1afeaada 100644 --- a/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: JwtAuthInterceptorOptions -Defined in: [packages/auth/src/types.ts:164](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L164) +Defined in: [packages/auth/src/types.ts:164](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L164) JWT auth interceptor options @@ -12,7 +12,7 @@ JWT auth interceptor options > `optional` **algorithms?**: `string`[] -Defined in: [packages/auth/src/types.ts:210](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L210) +Defined in: [packages/auth/src/types.ts:210](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L210) Allowed algorithms @@ -22,7 +22,7 @@ Allowed algorithms > `optional` **audience?**: `string` \| `string`[] -Defined in: [packages/auth/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L208) +Defined in: [packages/auth/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L208) Expected audience(s) @@ -32,7 +32,7 @@ Expected audience(s) > `optional` **claimsMapping?**: `object` -Defined in: [packages/auth/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L215) +Defined in: [packages/auth/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L215) Mapping from JWT claims to AuthContext fields. Supports dot-notation paths (e.g., "realm_access.roles"). @@ -59,7 +59,7 @@ Supports dot-notation paths (e.g., "realm_access.roles"). > `optional` **issuer?**: `string` \| `string`[] -Defined in: [packages/auth/src/types.ts:206](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L206) +Defined in: [packages/auth/src/types.ts:206](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L206) Expected issuer(s) @@ -69,7 +69,7 @@ Expected issuer(s) > `optional` **jwksUri?**: `string` -Defined in: [packages/auth/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L166) +Defined in: [packages/auth/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L166) JWKS endpoint URL for remote key set @@ -79,7 +79,7 @@ JWKS endpoint URL for remote key set > `optional` **maxTokenAge?**: `string` \| `number` -Defined in: [packages/auth/src/types.ts:228](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L228) +Defined in: [packages/auth/src/types.ts:228](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L228) Maximum token age. Passed to jose jwtVerify options. @@ -91,7 +91,7 @@ Number (seconds) or string (e.g., "2h", "7d"). > `optional` **propagateHeaders?**: `boolean` -Defined in: [packages/auth/src/types.ts:238](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L238) +Defined in: [packages/auth/src/types.ts:238](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L238) Propagate auth context as headers for downstream services. @@ -107,7 +107,7 @@ false > `optional` **publicKey?**: `CryptoKey` -Defined in: [packages/auth/src/types.ts:204](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L204) +Defined in: [packages/auth/src/types.ts:204](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L204) Asymmetric public key for JWT signature verification. @@ -155,7 +155,7 @@ const ecKey = await crypto.subtle.importKey( > `optional` **secret?**: `string` -Defined in: [packages/auth/src/types.ts:168](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L168) +Defined in: [packages/auth/src/types.ts:168](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L168) HMAC symmetric secret (for HS256/HS384/HS512) @@ -165,7 +165,7 @@ HMAC symmetric secret (for HS256/HS384/HS512) > `optional` **skipMethods?**: `string`[] -Defined in: [packages/auth/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L233) +Defined in: [packages/auth/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L233) Methods to skip authentication for. diff --git a/en/api/@connectum/auth/interfaces/MeshIdentityEntry.md b/en/api/@connectum/auth/interfaces/MeshIdentityEntry.md new file mode 100644 index 00000000..c801911f --- /dev/null +++ b/en/api/@connectum/auth/interfaces/MeshIdentityEntry.md @@ -0,0 +1,49 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / MeshIdentityEntry + +# Interface: MeshIdentityEntry + +Defined in: [packages/auth/src/types.ts:366](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L366) + +An allow-list entry for [meshIdentityTrust](../functions/meshIdentityTrust.md), mapping a verified mesh +identity (the forwarded peer principal) to its authorization context. + +## Properties + +### name? + +> `readonly` `optional` **name?**: `string` + +Defined in: [packages/auth/src/types.ts:377](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L377) + +Optional human-readable name for the calling service. + +*** + +### principal + +> `readonly` **principal**: `string` + +Defined in: [packages/auth/src/types.ts:371](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L371) + +The mesh-forwarded peer identity to match, e.g. an Istio short-form +ServiceAccount principal `cluster.local/ns//sa/` or a SPIFFE id. + +*** + +### roles? + +> `readonly` `optional` **roles?**: readonly `string`[] + +Defined in: [packages/auth/src/types.ts:373](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L373) + +Roles granted to this caller (compose via `requires {roles}`). + +*** + +### scopes? + +> `readonly` `optional` **scopes?**: readonly `string`[] + +Defined in: [packages/auth/src/types.ts:375](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L375) + +Scopes granted to this caller (compose via `requires {scopes}`). diff --git a/en/api/@connectum/auth/interfaces/MeshIdentityTrustOptions.md b/en/api/@connectum/auth/interfaces/MeshIdentityTrustOptions.md new file mode 100644 index 00000000..e55d7a21 --- /dev/null +++ b/en/api/@connectum/auth/interfaces/MeshIdentityTrustOptions.md @@ -0,0 +1,51 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / MeshIdentityTrustOptions + +# Interface: MeshIdentityTrustOptions + +Defined in: [packages/auth/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L383) + +Options for [meshIdentityTrust](../functions/meshIdentityTrust.md). + +## Properties + +### allowlist + +> `readonly` **allowlist**: readonly [`MeshIdentityEntry`](MeshIdentityEntry.md)[] + +Defined in: [packages/auth/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L389) + +Allow-list of permitted mesh identities. Each entry maps a forwarded peer +principal to its roles/scopes. A request whose identity is not on the +list is rejected. + +*** + +### header? + +> `readonly` `optional` **header?**: `string` + +Defined in: [packages/auth/src/types.ts:394](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L394) + +Header carrying the mesh-forwarded peer identity. + +#### Default + +```ts +"x-forwarded-client-principal" +``` + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +Defined in: [packages/auth/src/types.ts:396](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L396) + +Credential type set on the resulting AuthContext. + +#### Default + +```ts +"mesh" +``` diff --git a/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md b/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md index c6c29451..773b3c12 100644 --- a/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: ProtoAuthzInterceptorOptions -Defined in: [packages/auth/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L398) +Defined in: [packages/auth/src/types.ts:555](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L555) Proto-based authorization interceptor options. @@ -15,7 +15,7 @@ rules defined in .proto files. Falls back to programmatic rules and callbacks. > `optional` **authorize?**: (`context`, `req`) => `boolean` \| `Promise`\<`boolean`\> -Defined in: [packages/auth/src/types.ts:417](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L417) +Defined in: [packages/auth/src/types.ts:574](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L574) Programmatic authorization callback. Called when neither proto options nor programmatic rules match. @@ -52,7 +52,7 @@ true if authorized, false otherwise > `optional` **defaultPolicy?**: [`AuthzEffect`](../type-aliases/AuthzEffect.md) -Defined in: [packages/auth/src/types.ts:403](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L403) +Defined in: [packages/auth/src/types.ts:560](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L560) Default policy when no proto option and no rule match. @@ -68,7 +68,7 @@ Default policy when no proto option and no rule match. > `optional` **rules?**: [`AuthzRule`](AuthzRule.md)[] -Defined in: [packages/auth/src/types.ts:408](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L408) +Defined in: [packages/auth/src/types.ts:565](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L565) Additional programmatic rules, evaluated after proto options. Rules are evaluated in order; first matching rule wins. diff --git a/en/api/@connectum/auth/interfaces/ResolvedMethodAuth.md b/en/api/@connectum/auth/interfaces/ResolvedMethodAuth.md index 976c57a2..2be37c5a 100644 --- a/en/api/@connectum/auth/interfaces/ResolvedMethodAuth.md +++ b/en/api/@connectum/auth/interfaces/ResolvedMethodAuth.md @@ -2,7 +2,7 @@ # Interface: ResolvedMethodAuth -Defined in: [packages/auth/src/proto/reader.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/reader.ts#L20) +Defined in: [packages/auth/src/proto/reader.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L20) Resolved authorization configuration for a single RPC method. @@ -10,11 +10,23 @@ Result of merging service-level defaults with method-level overrides. ## Properties +### internal + +> `readonly` **internal**: `boolean` + +Defined in: [packages/auth/src/proto/reader.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L28) + +Whether the method is internal (service-to-service): skip end-user (JWT) +authentication, but require an internal trust marker established by +[createInternalAuthInterceptor](../functions/createInternalAuthInterceptor.md). Distinct from `public`. See ADR-029. + +*** + ### policy > `readonly` **policy**: `"allow"` \| `"deny"` \| `undefined` -Defined in: [packages/auth/src/proto/reader.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/reader.ts#L24) +Defined in: [packages/auth/src/proto/reader.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L30) Authorization policy: "allow", "deny", or undefined (use interceptor default). @@ -24,7 +36,7 @@ Authorization policy: "allow", "deny", or undefined (use interceptor default). > `readonly` **public**: `boolean` -Defined in: [packages/auth/src/proto/reader.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/reader.ts#L22) +Defined in: [packages/auth/src/proto/reader.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L22) Whether the method is public (skip authn + authz). @@ -34,6 +46,6 @@ Whether the method is public (skip authn + authz). > `readonly` **requires**: \{ `roles`: readonly `string`[]; `scopes`: readonly `string`[]; \} \| `undefined` -Defined in: [packages/auth/src/proto/reader.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/proto/reader.ts#L26) +Defined in: [packages/auth/src/proto/reader.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/proto/reader.ts#L32) Required roles and scopes, or undefined if none specified. diff --git a/en/api/@connectum/auth/interfaces/SessionAuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/SessionAuthInterceptorOptions.md index c65d4e20..752df840 100644 --- a/en/api/@connectum/auth/interfaces/SessionAuthInterceptorOptions.md +++ b/en/api/@connectum/auth/interfaces/SessionAuthInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: SessionAuthInterceptorOptions -Defined in: [packages/auth/src/types.ts:326](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L326) +Defined in: [packages/auth/src/types.ts:483](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L483) Session-based auth interceptor options. @@ -14,7 +14,7 @@ Two-step authentication: verify session token, then map session data to AuthCont > `readonly` `optional` **cache?**: [`CacheOptions`](CacheOptions.md) -Defined in: [packages/auth/src/types.ts:349](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L349) +Defined in: [packages/auth/src/types.ts:506](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L506) LRU cache for session verification results @@ -24,7 +24,7 @@ LRU cache for session verification results > `readonly` `optional` **extractToken?**: (`req`) => `string` \| `Promise`\<`string` \| `null`\> \| `null` -Defined in: [packages/auth/src/types.ts:347](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L347) +Defined in: [packages/auth/src/types.ts:504](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L504) Custom token extraction. Default: extracts Bearer token from Authorization header. @@ -47,7 +47,7 @@ Default: extracts Bearer token from Authorization header. > `readonly` **mapSession**: (`session`) => [`AuthContext`](AuthContext.md) \| `Promise`\<[`AuthContext`](AuthContext.md)\> -Defined in: [packages/auth/src/types.ts:342](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L342) +Defined in: [packages/auth/src/types.ts:499](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L499) Map raw session data to AuthContext. @@ -71,7 +71,7 @@ Normalized auth context > `readonly` `optional` **propagatedClaims?**: `string`[] -Defined in: [packages/auth/src/types.ts:359](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L359) +Defined in: [packages/auth/src/types.ts:516](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L516) Filter which claims are propagated in headers. When set, only listed claim keys are included in x-auth-claims header. @@ -83,7 +83,7 @@ When not set, all claims are propagated. > `readonly` `optional` **propagateHeaders?**: `boolean` -Defined in: [packages/auth/src/types.ts:353](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L353) +Defined in: [packages/auth/src/types.ts:510](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L510) Propagate auth context as headers for downstream services @@ -93,7 +93,7 @@ Propagate auth context as headers for downstream services > `readonly` `optional` **skipMethods?**: `string`[] -Defined in: [packages/auth/src/types.ts:351](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L351) +Defined in: [packages/auth/src/types.ts:508](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L508) Methods to skip authentication for @@ -103,7 +103,7 @@ Methods to skip authentication for > `readonly` **verifySession**: (`token`, `headers`) => `unknown` -Defined in: [packages/auth/src/types.ts:335](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L335) +Defined in: [packages/auth/src/types.ts:492](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L492) Verify session token and return raw session data. Must throw on invalid/expired sessions. diff --git a/en/api/@connectum/auth/interfaces/SharedSecretTrustOptions.md b/en/api/@connectum/auth/interfaces/SharedSecretTrustOptions.md new file mode 100644 index 00000000..82bcbe60 --- /dev/null +++ b/en/api/@connectum/auth/interfaces/SharedSecretTrustOptions.md @@ -0,0 +1,89 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / SharedSecretTrustOptions + +# Interface: SharedSecretTrustOptions + +Defined in: [packages/auth/src/types.ts:457](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L457) + +Options for [sharedSecretTrust](../functions/sharedSecretTrust.md). + +DEV-ONLY: a single shared secret is NOT per-service — one compromise forges +all callers. Use [meshIdentityTrust](../functions/meshIdentityTrust.md) or [signedTokenTrust](../functions/signedTokenTrust.md) in +production. See ADR-029. + +## Properties + +### header? + +> `readonly` `optional` **header?**: `string` + +Defined in: [packages/auth/src/types.ts:464](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L464) + +Header carrying the shared secret. + +#### Default + +```ts +"x-internal-secret" +``` + +*** + +### roles? + +> `readonly` `optional` **roles?**: readonly `string`[] + +Defined in: [packages/auth/src/types.ts:471](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L471) + +Roles granted to a trusted caller. + +*** + +### scopes? + +> `readonly` `optional` **scopes?**: readonly `string`[] + +Defined in: [packages/auth/src/types.ts:473](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L473) + +Scopes granted to a trusted caller. + +*** + +### secret + +> `readonly` **secret**: `string` + +Defined in: [packages/auth/src/types.ts:459](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L459) + +The shared secret, constant-time compared against the header value. + +*** + +### subject? + +> `readonly` `optional` **subject?**: `string` + +Defined in: [packages/auth/src/types.ts:469](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L469) + +Subject identity assigned to a trusted call. + +#### Default + +```ts +"internal" +``` + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +Defined in: [packages/auth/src/types.ts:475](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L475) + +Credential type set on the resulting AuthContext. + +#### Default + +```ts +"internal" +``` diff --git a/en/api/@connectum/auth/interfaces/SignedTokenIssuer.md b/en/api/@connectum/auth/interfaces/SignedTokenIssuer.md new file mode 100644 index 00000000..519ddda6 --- /dev/null +++ b/en/api/@connectum/auth/interfaces/SignedTokenIssuer.md @@ -0,0 +1,85 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / SignedTokenIssuer + +# Interface: SignedTokenIssuer + +Defined in: [packages/auth/src/types.ts:407](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L407) + +Per-issuer JWKS configuration for [signedTokenTrust](../functions/signedTokenTrust.md). + +The JWKS lookup is issuer-bound: the keyset is selected by the token's `iss` +claim and verification is pinned to that same issuer. This is a hard security +requirement — a single shared JWKS holding multiple services' keys does NOT +contain compromise (jose resolves the key by `kid` independently of `iss`). + +## Properties + +### algorithms? + +> `readonly` `optional` **algorithms?**: `string`[] + +Defined in: [packages/auth/src/types.ts:413](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L413) + +Allowed signing algorithms. + +#### Default + +```ts +["RS256"] +``` + +*** + +### audience? + +> `readonly` `optional` **audience?**: `string` \| `string`[] + +Defined in: [packages/auth/src/types.ts:411](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L411) + +Expected audience(s) for tokens from this issuer. + +*** + +### claimsMapping? + +> `readonly` `optional` **claimsMapping?**: `object` + +Defined in: [packages/auth/src/types.ts:420](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L420) + +Mapping from token claims to AuthContext fields (dot-notation paths). +`subject` defaults to `sub ?? iss`; `roles`/`scopes` to none unless mapped. + +#### name? + +> `readonly` `optional` **name?**: `string` + +#### roles? + +> `readonly` `optional` **roles?**: `string` + +#### scopes? + +> `readonly` `optional` **scopes?**: `string` + +#### subject? + +> `readonly` `optional` **subject?**: `string` + +*** + +### jwksUri + +> `readonly` **jwksUri**: `string` + +Defined in: [packages/auth/src/types.ts:409](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L409) + +The issuer's JWKS endpoint URL (its own keyset only). + +*** + +### maxTokenAge? + +> `readonly` `optional` **maxTokenAge?**: `string` \| `number` + +Defined in: [packages/auth/src/types.ts:415](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L415) + +Maximum token age (seconds or string like "2h"). diff --git a/en/api/@connectum/auth/interfaces/SignedTokenTrustOptions.md b/en/api/@connectum/auth/interfaces/SignedTokenTrustOptions.md new file mode 100644 index 00000000..1659d7ba --- /dev/null +++ b/en/api/@connectum/auth/interfaces/SignedTokenTrustOptions.md @@ -0,0 +1,52 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / SignedTokenTrustOptions + +# Interface: SignedTokenTrustOptions + +Defined in: [packages/auth/src/types.ts:433](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L433) + +Options for [signedTokenTrust](../functions/signedTokenTrust.md). + +## Properties + +### header? + +> `readonly` `optional` **header?**: `string` + +Defined in: [packages/auth/src/types.ts:445](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L445) + +Header carrying the service token. The value may be a bare token or a +`Bearer ` value. + +#### Default + +```ts +"x-internal-token" +``` + +*** + +### issuers + +> `readonly` **issuers**: `Readonly`\<`Record`\<`string`, [`SignedTokenIssuer`](SignedTokenIssuer.md)\>\> + +Defined in: [packages/auth/src/types.ts:439](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L439) + +Per-issuer configuration keyed by the issuer (`iss`) value. The keyset is +selected by the token's claimed issuer and verification is pinned to that +same issuer — never a single shared keyset across issuers. + +*** + +### type? + +> `readonly` `optional` **type?**: `string` + +Defined in: [packages/auth/src/types.ts:447](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L447) + +Credential type set on the resulting AuthContext. + +#### Default + +```ts +"service" +``` diff --git a/en/api/@connectum/auth/proto/index.md b/en/api/@connectum/auth/proto/index.md index 6af1ec89..001922cf 100644 --- a/en/api/@connectum/auth/proto/index.md +++ b/en/api/@connectum/auth/proto/index.md @@ -30,6 +30,12 @@ Re-exports [createProtoAuthzInterceptor](../functions/createProtoAuthzIntercepto *** +### getInternalMethods + +Re-exports [getInternalMethods](../functions/getInternalMethods.md) + +*** + ### getPublicMethods Re-exports [getPublicMethods](../functions/getPublicMethods.md) diff --git a/en/api/@connectum/auth/proto/type-aliases/MethodAuth.md b/en/api/@connectum/auth/proto/type-aliases/MethodAuth.md index 4f3355aa..e6005a94 100644 --- a/en/api/@connectum/auth/proto/type-aliases/MethodAuth.md +++ b/en/api/@connectum/auth/proto/type-aliases/MethodAuth.md @@ -10,6 +10,21 @@ Authorization configuration for an RPC method. ## Type Declaration +### internal + +> **internal**: `boolean` + +Mark the method as internal (service-to-service). Skips end-user (JWT) +authentication, but requires an internal trust marker established by +createInternalAuthInterceptor (a per-service trust source). Distinct from +`public`: `public` is world-open (no auth at all); `internal` is reachable +only by a trusted internal caller. A method is at most one of +`public` / `internal` / gated. See ADR-029. + +#### Generated + +from field: optional bool internal = 4; + ### policy > **policy**: `string` diff --git a/en/api/@connectum/auth/proto/type-aliases/ServiceAuth.md b/en/api/@connectum/auth/proto/type-aliases/ServiceAuth.md index 624f7de7..f16d26b5 100644 --- a/en/api/@connectum/auth/proto/type-aliases/ServiceAuth.md +++ b/en/api/@connectum/auth/proto/type-aliases/ServiceAuth.md @@ -4,7 +4,7 @@ > **ServiceAuth** = `Message`\<`"connectum.auth.v1.ServiceAuth"`\> & `object` -Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:70 +Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:81 Default authorization configuration for all methods in a service. @@ -32,6 +32,19 @@ unless overridden at the method level. from field: optional connectum.auth.v1.AuthRequirements default_requires = 2; +### internal + +> **internal**: `boolean` + +Mark all methods in the service as internal (service-to-service). +Skips end-user (JWT) authentication, but requires an internal trust +marker established by createInternalAuthInterceptor. Method-level +`internal` overrides this. See ADR-029. + +#### Generated + +from field: optional bool internal = 4; + ### public > **public**: `boolean` diff --git a/en/api/@connectum/auth/proto/variables/MethodAuthSchema.md b/en/api/@connectum/auth/proto/variables/MethodAuthSchema.md index de3f7aea..f17c1d4d 100644 --- a/en/api/@connectum/auth/proto/variables/MethodAuthSchema.md +++ b/en/api/@connectum/auth/proto/variables/MethodAuthSchema.md @@ -4,7 +4,7 @@ > `const` **MethodAuthSchema**: `GenMessage`\<[`MethodAuth`](../type-aliases/MethodAuth.md)\> -Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:64 +Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:75 Describes the message connectum.auth.v1.MethodAuth. Use `create(MethodAuthSchema)` to create a new message. diff --git a/en/api/@connectum/auth/proto/variables/ServiceAuthSchema.md b/en/api/@connectum/auth/proto/variables/ServiceAuthSchema.md index 4ca82b4f..825d933b 100644 --- a/en/api/@connectum/auth/proto/variables/ServiceAuthSchema.md +++ b/en/api/@connectum/auth/proto/variables/ServiceAuthSchema.md @@ -4,7 +4,7 @@ > `const` **ServiceAuthSchema**: `GenMessage`\<[`ServiceAuth`](../type-aliases/ServiceAuth.md)\> -Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:97 +Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:117 Describes the message connectum.auth.v1.ServiceAuth. Use `create(ServiceAuthSchema)` to create a new message. diff --git a/en/api/@connectum/auth/proto/variables/method_auth.md b/en/api/@connectum/auth/proto/variables/method_auth.md index 4aec6fbc..f1d3c1b3 100644 --- a/en/api/@connectum/auth/proto/variables/method_auth.md +++ b/en/api/@connectum/auth/proto/variables/method_auth.md @@ -4,7 +4,7 @@ > `const` **method\_auth**: `GenExtension`\<`MethodOptions`, [`MethodAuth`](../type-aliases/MethodAuth.md)\> -Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:101 +Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:121 ## Generated diff --git a/en/api/@connectum/auth/proto/variables/service_auth.md b/en/api/@connectum/auth/proto/variables/service_auth.md index 9876ae81..dc935699 100644 --- a/en/api/@connectum/auth/proto/variables/service_auth.md +++ b/en/api/@connectum/auth/proto/variables/service_auth.md @@ -4,7 +4,7 @@ > `const` **service\_auth**: `GenExtension`\<`ServiceOptions`, [`ServiceAuth`](../type-aliases/ServiceAuth.md)\> -Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:105 +Defined in: packages/auth/gen/connectum/auth/v1/options\_pb.d.ts:125 ## Generated diff --git a/en/api/@connectum/auth/testing/functions/createMockAuthContext.md b/en/api/@connectum/auth/testing/functions/createMockAuthContext.md index ad641b56..6977cc20 100644 --- a/en/api/@connectum/auth/testing/functions/createMockAuthContext.md +++ b/en/api/@connectum/auth/testing/functions/createMockAuthContext.md @@ -4,7 +4,7 @@ > **createMockAuthContext**(`overrides?`): [`AuthContext`](../../interfaces/AuthContext.md) -Defined in: [packages/auth/src/testing/mock-context.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/testing/mock-context.ts#L39) +Defined in: [packages/auth/src/testing/mock-context.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/mock-context.ts#L39) Create a mock AuthContext for testing. diff --git a/en/api/@connectum/auth/testing/functions/createTestJwt.md b/en/api/@connectum/auth/testing/functions/createTestJwt.md index 8ee5ecbd..b2f8f7c0 100644 --- a/en/api/@connectum/auth/testing/functions/createTestJwt.md +++ b/en/api/@connectum/auth/testing/functions/createTestJwt.md @@ -4,7 +4,7 @@ > **createTestJwt**(`payload`, `options?`): `Promise`\<`string`\> -Defined in: [packages/auth/src/testing/test-jwt.ts:49](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/testing/test-jwt.ts#L49) +Defined in: [packages/auth/src/testing/test-jwt.ts:49](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt.ts#L49) Create a signed test JWT for integration testing. diff --git a/en/api/@connectum/auth/testing/functions/createTestJwtRS256.md b/en/api/@connectum/auth/testing/functions/createTestJwtRS256.md new file mode 100644 index 00000000..529fe72f --- /dev/null +++ b/en/api/@connectum/auth/testing/functions/createTestJwtRS256.md @@ -0,0 +1,51 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/auth](../../index.md) / [testing](../index.md) / createTestJwtRS256 + +# Function: createTestJwtRS256() + +> **createTestJwtRS256**(`privateKey`, `payload`, `options`): `Promise`\<`string`\> + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:133](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L133) + +Mint an RS256 test JWT signed by the private key from +[generateRsaTestKeypair](generateRsaTestKeypair.md), with a `kid` header matching the published JWK. + +NOT for production use. + +## Parameters + +### privateKey + +`CryptoKey` + +Private key from [generateRsaTestKeypair](generateRsaTestKeypair.md). + +### payload + +`Record`\<`string`, `unknown`\> + +JWT claims (e.g. `sub`, `roles`, `scope`). + +### options + +`kid` (required, must match the published JWK) plus optional + `issuer`/`audience`/`expiresIn` (default `"1h"`). + +#### audience? + +`string` + +#### expiresIn? + +`string` + +#### issuer? + +`string` + +#### kid + +`string` + +## Returns + +`Promise`\<`string`\> diff --git a/en/api/@connectum/auth/testing/functions/generateRsaTestKeypair.md b/en/api/@connectum/auth/testing/functions/generateRsaTestKeypair.md new file mode 100644 index 00000000..6941bfe6 --- /dev/null +++ b/en/api/@connectum/auth/testing/functions/generateRsaTestKeypair.md @@ -0,0 +1,25 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/auth](../../index.md) / [testing](../index.md) / generateRsaTestKeypair + +# Function: generateRsaTestKeypair() + +> **generateRsaTestKeypair**(`kid?`): `Promise`\<[`RsaTestKeypair`](../interfaces/RsaTestKeypair.md)\> + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:73](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L73) + +Generate an RSA (RS256) test keypair and the matching public JWK. + +The returned `publicJwk` carries the `kid`/`alg`/`use` a JWKS endpoint +publishes, and the same `kid` must be set on every token minted for it +(otherwise `createRemoteJWKSet` fails key selection). + +## Parameters + +### kid? + +`string` = `TEST_JWT_KID` + +Key id to stamp on the JWK; defaults to [TEST\_JWT\_KID](../variables/TEST_JWT_KID.md). + +## Returns + +`Promise`\<[`RsaTestKeypair`](../interfaces/RsaTestKeypair.md)\> diff --git a/en/api/@connectum/auth/testing/functions/startTestJwksServer.md b/en/api/@connectum/auth/testing/functions/startTestJwksServer.md new file mode 100644 index 00000000..2a8939c5 --- /dev/null +++ b/en/api/@connectum/auth/testing/functions/startTestJwksServer.md @@ -0,0 +1,22 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/auth](../../index.md) / [testing](../index.md) / startTestJwksServer + +# Function: startTestJwksServer() + +> **startTestJwksServer**(`jwks`): `Promise`\<[`TestJwksServer`](../interfaces/TestJwksServer.md)\> + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:95](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L95) + +Start an ephemeral in-process JWKS server publishing the given public JWK(s) +at `/.well-known/jwks.json` on a random loopback port. + +## Parameters + +### jwks + +`JWK` \| readonly `JWK`[] + +One public JWK or an array (from [generateRsaTestKeypair](generateRsaTestKeypair.md)). + +## Returns + +`Promise`\<[`TestJwksServer`](../interfaces/TestJwksServer.md)\> diff --git a/en/api/@connectum/auth/testing/functions/withAuthContext.md b/en/api/@connectum/auth/testing/functions/withAuthContext.md index 40b16a07..383597bb 100644 --- a/en/api/@connectum/auth/testing/functions/withAuthContext.md +++ b/en/api/@connectum/auth/testing/functions/withAuthContext.md @@ -4,7 +4,7 @@ > **withAuthContext**\<`T`\>(`context`, `fn`): `Promise`\<`T`\> -Defined in: [packages/auth/src/testing/with-context.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/testing/with-context.ts#L31) +Defined in: [packages/auth/src/testing/with-context.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/with-context.ts#L31) Run a function with a pre-set AuthContext. diff --git a/en/api/@connectum/auth/testing/index.md b/en/api/@connectum/auth/testing/index.md index f041c5c8..1c4a9e9d 100644 --- a/en/api/@connectum/auth/testing/index.md +++ b/en/api/@connectum/auth/testing/index.md @@ -6,12 +6,21 @@ Test utilities for authentication and authorization. +## Interfaces + +- [RsaTestKeypair](interfaces/RsaTestKeypair.md) +- [TestJwksServer](interfaces/TestJwksServer.md) + ## Variables +- [TEST\_JWT\_KID](variables/TEST_JWT_KID.md) - [TEST\_JWT\_SECRET](variables/TEST_JWT_SECRET.md) ## Functions - [createMockAuthContext](functions/createMockAuthContext.md) - [createTestJwt](functions/createTestJwt.md) +- [createTestJwtRS256](functions/createTestJwtRS256.md) +- [generateRsaTestKeypair](functions/generateRsaTestKeypair.md) +- [startTestJwksServer](functions/startTestJwksServer.md) - [withAuthContext](functions/withAuthContext.md) diff --git a/en/api/@connectum/auth/testing/interfaces/RsaTestKeypair.md b/en/api/@connectum/auth/testing/interfaces/RsaTestKeypair.md new file mode 100644 index 00000000..f08eea63 --- /dev/null +++ b/en/api/@connectum/auth/testing/interfaces/RsaTestKeypair.md @@ -0,0 +1,47 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/auth](../../index.md) / [testing](../index.md) / RsaTestKeypair + +# Interface: RsaTestKeypair + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L53) + +A generated RSA test keypair plus the public JWK to publish at a JWKS endpoint. + +## Properties + +### kid + +> `readonly` **kid**: `string` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:61](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L61) + +Key id shared by `publicJwk` and the token header (load-bearing for JWKS key selection). + +*** + +### privateKey + +> `readonly` **privateKey**: `CryptoKey` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:55](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L55) + +Private signing key — pass to [createTestJwtRS256](../functions/createTestJwtRS256.md). + +*** + +### publicJwk + +> `readonly` **publicJwk**: `JWK` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L59) + +Public JWK (carries `kid`, `alg: "RS256"`, `use: "sig"`) — serve at the JWKS endpoint. + +*** + +### publicKey + +> `readonly` **publicKey**: `CryptoKey` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:57](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L57) + +Public verification key. diff --git a/en/api/@connectum/auth/testing/interfaces/TestJwksServer.md b/en/api/@connectum/auth/testing/interfaces/TestJwksServer.md new file mode 100644 index 00000000..92e4f8a0 --- /dev/null +++ b/en/api/@connectum/auth/testing/interfaces/TestJwksServer.md @@ -0,0 +1,41 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/auth](../../index.md) / [testing](../index.md) / TestJwksServer + +# Interface: TestJwksServer + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:80](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L80) + +A running in-process JWKS server. + +## Properties + +### origin + +> `readonly` **origin**: `string` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:84](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L84) + +Origin (no path), e.g. `http://127.0.0.1:`. + +*** + +### url + +> `readonly` **url**: `string` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:82](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L82) + +The JWKS URL — pass as `jwksUri` to `createJwtAuthInterceptor`. + +## Methods + +### close() + +> **close**(): `Promise`\<`void`\> + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L86) + +Stop the server. Call after the test (e.g. in `after`). + +#### Returns + +`Promise`\<`void`\> diff --git a/en/api/@connectum/auth/testing/variables/TEST_JWT_KID.md b/en/api/@connectum/auth/testing/variables/TEST_JWT_KID.md new file mode 100644 index 00000000..76f772af --- /dev/null +++ b/en/api/@connectum/auth/testing/variables/TEST_JWT_KID.md @@ -0,0 +1,9 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/auth](../../index.md) / [testing](../index.md) / TEST\_JWT\_KID + +# Variable: TEST\_JWT\_KID + +> `const` **TEST\_JWT\_KID**: `"connectum-test-key"` = `"connectum-test-key"` + +Defined in: [packages/auth/src/testing/test-jwt-rs256.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt-rs256.ts#L50) + +Default `kid` shared by the generated keypair and the minted tokens. diff --git a/en/api/@connectum/auth/testing/variables/TEST_JWT_SECRET.md b/en/api/@connectum/auth/testing/variables/TEST_JWT_SECRET.md index 75e9e575..2d44f5ee 100644 --- a/en/api/@connectum/auth/testing/variables/TEST_JWT_SECRET.md +++ b/en/api/@connectum/auth/testing/variables/TEST_JWT_SECRET.md @@ -4,7 +4,7 @@ > `const` **TEST\_JWT\_SECRET**: `"connectum-test-secret-do-not-use-in-production"` = `"connectum-test-secret-do-not-use-in-production"` -Defined in: [packages/auth/src/testing/test-jwt.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/testing/test-jwt.ts#L18) +Defined in: [packages/auth/src/testing/test-jwt.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/testing/test-jwt.ts#L18) Deterministic test secret for HS256 JWTs. diff --git a/en/api/@connectum/auth/type-aliases/AuthzEffect.md b/en/api/@connectum/auth/type-aliases/AuthzEffect.md index 6f50cdd2..5327f175 100644 --- a/en/api/@connectum/auth/type-aliases/AuthzEffect.md +++ b/en/api/@connectum/auth/type-aliases/AuthzEffect.md @@ -4,6 +4,6 @@ > **AuthzEffect** = *typeof* [`AuthzEffect`](../variables/AuthzEffect.md)\[keyof *typeof* [`AuthzEffect`](../variables/AuthzEffect.md)\] -Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L67) +Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L67) Authorization rule effect diff --git a/en/api/@connectum/auth/type-aliases/InterceptorFactory.md b/en/api/@connectum/auth/type-aliases/InterceptorFactory.md index 19ef96c5..b4c456f2 100644 --- a/en/api/@connectum/auth/type-aliases/InterceptorFactory.md +++ b/en/api/@connectum/auth/type-aliases/InterceptorFactory.md @@ -4,7 +4,7 @@ > **InterceptorFactory**\<`TOptions`\> = `TOptions` *extends* `void` ? () => `Interceptor` : (`options`) => `Interceptor` -Defined in: [packages/auth/src/types.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L14) +Defined in: [packages/auth/src/types.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L14) Interceptor factory function type diff --git a/en/api/@connectum/auth/type-aliases/InternalTrustSource.md b/en/api/@connectum/auth/type-aliases/InternalTrustSource.md new file mode 100644 index 00000000..ea81bc21 --- /dev/null +++ b/en/api/@connectum/auth/type-aliases/InternalTrustSource.md @@ -0,0 +1,34 @@ +[Connectum API Reference](../../../index.md) / [@connectum/auth](../index.md) / InternalTrustSource + +# Type Alias: InternalTrustSource + +> **InternalTrustSource** = (`req`) => [`AuthContext`](../interfaces/AuthContext.md) \| `null` \| `Promise`\<[`AuthContext`](../interfaces/AuthContext.md) \| `null`\> + +Defined in: [packages/auth/src/types.ts:336](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L336) + +A pluggable internal trust source (ADR-029). + +Given the incoming request, returns an [AuthContext](../interfaces/AuthContext.md) for the calling +service when the internal trust marker is present and valid, or `null` when +it is missing/invalid. [createInternalAuthInterceptor](../functions/createInternalAuthInterceptor.md) converts `null` +(and any thrown error from the trust source) into `Code.Unauthenticated`. + +The returned `AuthContext.subject` is the service identity; `roles`/`scopes` +come from the trust source (allow-list entry or verified token claims) so the +call composes with the existing `requires {roles,scopes}` authz model. + +## Parameters + +### req + +The request (read-only access to headers). + +#### header + +`Headers` + +## Returns + +[`AuthContext`](../interfaces/AuthContext.md) \| `null` \| `Promise`\<[`AuthContext`](../interfaces/AuthContext.md) \| `null`\> + +AuthContext for a trusted internal caller, or null to reject. diff --git a/en/api/@connectum/auth/variables/AUTH_HEADERS.md b/en/api/@connectum/auth/variables/AUTH_HEADERS.md index 63d1e772..0f0cd95f 100644 --- a/en/api/@connectum/auth/variables/AUTH_HEADERS.md +++ b/en/api/@connectum/auth/variables/AUTH_HEADERS.md @@ -4,7 +4,7 @@ > `const` **AUTH\_HEADERS**: `object` -Defined in: [packages/auth/src/types.ts:49](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L49) +Defined in: [packages/auth/src/types.ts:49](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L49) Standard header names for auth context propagation. diff --git a/en/api/@connectum/auth/variables/AuthzEffect.md b/en/api/@connectum/auth/variables/AuthzEffect.md index 4706da7a..47c43bff 100644 --- a/en/api/@connectum/auth/variables/AuthzEffect.md +++ b/en/api/@connectum/auth/variables/AuthzEffect.md @@ -4,7 +4,7 @@ > `const` **AuthzEffect**: `object` -Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/types.ts#L67) +Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/types.ts#L67) Authorization rule effect diff --git a/en/api/@connectum/auth/variables/authContextStorage.md b/en/api/@connectum/auth/variables/authContextStorage.md index 4b986d2e..b72b000e 100644 --- a/en/api/@connectum/auth/variables/authContextStorage.md +++ b/en/api/@connectum/auth/variables/authContextStorage.md @@ -4,7 +4,7 @@ > `const` **authContextStorage**: `AsyncLocalStorage`\<[`AuthContext`](../interfaces/AuthContext.md)\> -Defined in: [packages/auth/src/context.ts:87](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/auth/src/context.ts#L87) +Defined in: [packages/auth/src/context.ts:87](https://github.com/Connectum-Framework/connectum/blob/main/packages/auth/src/context.ts#L87) Process-wide AsyncLocalStorage for auth context. diff --git a/en/api/@connectum/cli/commands/proto-sync/functions/executeProtoSync.md b/en/api/@connectum/cli/commands/proto-sync/functions/executeProtoSync.md index a0ec6996..7683ca54 100644 --- a/en/api/@connectum/cli/commands/proto-sync/functions/executeProtoSync.md +++ b/en/api/@connectum/cli/commands/proto-sync/functions/executeProtoSync.md @@ -4,7 +4,7 @@ > **executeProtoSync**(`options`): `Promise`\<`void`\> -Defined in: [commands/proto-sync.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L41) +Defined in: [commands/proto-sync.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L41) Execute the proto sync pipeline. diff --git a/en/api/@connectum/cli/commands/proto-sync/interfaces/ProtoSyncOptions.md b/en/api/@connectum/cli/commands/proto-sync/interfaces/ProtoSyncOptions.md index 86c3b7de..e3393051 100644 --- a/en/api/@connectum/cli/commands/proto-sync/interfaces/ProtoSyncOptions.md +++ b/en/api/@connectum/cli/commands/proto-sync/interfaces/ProtoSyncOptions.md @@ -2,7 +2,7 @@ # Interface: ProtoSyncOptions -Defined in: [commands/proto-sync.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L25) +Defined in: [commands/proto-sync.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L25) Options for the proto sync pipeline. @@ -12,7 +12,7 @@ Options for the proto sync pipeline. > `optional` **dryRun?**: `boolean` -Defined in: [commands/proto-sync.ts:33](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L33) +Defined in: [commands/proto-sync.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L33) Show what would be synced without generating @@ -22,7 +22,7 @@ Show what would be synced without generating > **from**: `string` -Defined in: [commands/proto-sync.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L27) +Defined in: [commands/proto-sync.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L27) Server URL (e.g., "http://localhost:5000") @@ -32,7 +32,7 @@ Server URL (e.g., "http://localhost:5000") > **out**: `string` -Defined in: [commands/proto-sync.ts:29](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L29) +Defined in: [commands/proto-sync.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L29) Output directory for generated types @@ -42,6 +42,6 @@ Output directory for generated types > `optional` **template?**: `string` -Defined in: [commands/proto-sync.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L31) +Defined in: [commands/proto-sync.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L31) Path to custom buf.gen.yaml template diff --git a/en/api/@connectum/cli/commands/proto-sync/variables/protoSyncCommand.md b/en/api/@connectum/cli/commands/proto-sync/variables/protoSyncCommand.md index 6ea69ff2..3478c636 100644 --- a/en/api/@connectum/cli/commands/proto-sync/variables/protoSyncCommand.md +++ b/en/api/@connectum/cli/commands/proto-sync/variables/protoSyncCommand.md @@ -4,6 +4,6 @@ > `const` **protoSyncCommand**: `CommandDef`\<\{ `dry-run`: \{ `default`: `false`; `description`: `"Show what would be synced without generating code"`; `type`: `"boolean"`; \}; `from`: \{ `description`: `"Server address (e.g., localhost:5000 or http://localhost:5000)"`; `required`: `true`; `type`: `"string"`; \}; `out`: \{ `description`: `"Output directory for generated types"`; `required`: `true`; `type`: `"string"`; \}; `template`: \{ `description`: `"Path to custom buf.gen.yaml template"`; `type`: `"string"`; \}; \}\> -Defined in: [commands/proto-sync.ts:113](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/commands/proto-sync.ts#L113) +Defined in: [commands/proto-sync.ts:113](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/commands/proto-sync.ts#L113) citty command definition for `connectum proto sync`. diff --git a/en/api/@connectum/cli/utils/reflection/functions/fetchFileDescriptorSetBinary.md b/en/api/@connectum/cli/utils/reflection/functions/fetchFileDescriptorSetBinary.md index 76caf3b0..71462efa 100644 --- a/en/api/@connectum/cli/utils/reflection/functions/fetchFileDescriptorSetBinary.md +++ b/en/api/@connectum/cli/utils/reflection/functions/fetchFileDescriptorSetBinary.md @@ -4,7 +4,7 @@ > **fetchFileDescriptorSetBinary**(`url`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\> -Defined in: [utils/reflection.ts:72](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/utils/reflection.ts#L72) +Defined in: [utils/reflection.ts:72](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/utils/reflection.ts#L72) Fetch FileDescriptorSet as binary (.binpb) from a running server via reflection. diff --git a/en/api/@connectum/cli/utils/reflection/functions/fetchReflectionData.md b/en/api/@connectum/cli/utils/reflection/functions/fetchReflectionData.md index 71e1d54d..b159996d 100644 --- a/en/api/@connectum/cli/utils/reflection/functions/fetchReflectionData.md +++ b/en/api/@connectum/cli/utils/reflection/functions/fetchReflectionData.md @@ -4,7 +4,7 @@ > **fetchReflectionData**(`url`): `Promise`\<[`ReflectionResult`](../interfaces/ReflectionResult.md)\> -Defined in: [utils/reflection.ts:42](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/utils/reflection.ts#L42) +Defined in: [utils/reflection.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/utils/reflection.ts#L42) Fetch service and file descriptor information from a running server via reflection. diff --git a/en/api/@connectum/cli/utils/reflection/interfaces/ReflectionResult.md b/en/api/@connectum/cli/utils/reflection/interfaces/ReflectionResult.md index 5cc9ea56..dd982cd0 100644 --- a/en/api/@connectum/cli/utils/reflection/interfaces/ReflectionResult.md +++ b/en/api/@connectum/cli/utils/reflection/interfaces/ReflectionResult.md @@ -2,7 +2,7 @@ # Interface: ReflectionResult -Defined in: [utils/reflection.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/utils/reflection.ts#L19) +Defined in: [utils/reflection.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/utils/reflection.ts#L19) Result of fetching proto descriptors from a running server. @@ -12,7 +12,7 @@ Result of fetching proto descriptors from a running server. > **fileNames**: `string`[] -Defined in: [utils/reflection.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/utils/reflection.ts#L25) +Defined in: [utils/reflection.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/utils/reflection.ts#L25) Proto file names in the registry @@ -22,7 +22,7 @@ Proto file names in the registry > **registry**: `FileRegistry` -Defined in: [utils/reflection.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/utils/reflection.ts#L23) +Defined in: [utils/reflection.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/utils/reflection.ts#L23) FileRegistry containing all discovered file descriptors @@ -32,6 +32,6 @@ FileRegistry containing all discovered file descriptors > **services**: `string`[] -Defined in: [utils/reflection.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/cli/src/utils/reflection.ts#L21) +Defined in: [utils/reflection.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/cli/src/utils/reflection.ts#L21) List of fully-qualified service names diff --git a/en/api/@connectum/core/classes/CatalogConfigError.md b/en/api/@connectum/core/classes/CatalogConfigError.md index e9139cb1..a3b6f1b7 100644 --- a/en/api/@connectum/core/classes/CatalogConfigError.md +++ b/en/api/@connectum/core/classes/CatalogConfigError.md @@ -2,7 +2,7 @@ # Class: CatalogConfigError -Defined in: [packages/core/src/catalogErrors.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/catalogErrors.ts#L18) +Defined in: [packages/core/src/catalogErrors.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogErrors.ts#L18) ## Extends @@ -14,7 +14,7 @@ Defined in: [packages/core/src/catalogErrors.ts:18](https://github.com/Connectum > **new CatalogConfigError**(`message`): `CatalogConfigError` -Defined in: [packages/core/src/catalogErrors.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/catalogErrors.ts#L21) +Defined in: [packages/core/src/catalogErrors.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogErrors.ts#L21) #### Parameters @@ -60,7 +60,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `readonly` **name**: `"CatalogConfigError"` = `"CatalogConfigError"` -Defined in: [packages/core/src/catalogErrors.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/catalogErrors.ts#L19) +Defined in: [packages/core/src/catalogErrors.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogErrors.ts#L19) #### Overrides diff --git a/en/api/@connectum/core/classes/TransportValidationError.md b/en/api/@connectum/core/classes/TransportValidationError.md index 200699d1..a8f940fa 100644 --- a/en/api/@connectum/core/classes/TransportValidationError.md +++ b/en/api/@connectum/core/classes/TransportValidationError.md @@ -2,7 +2,7 @@ # Class: TransportValidationError -Defined in: [packages/core/src/TransportValidation.ts:90](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L90) +Defined in: [packages/core/src/TransportValidation.ts:90](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L90) Startup validation error: bidi-streaming methods registered on a transport that cannot carry them. Carries the stable @@ -18,7 +18,7 @@ transport that cannot carry them. Carries the stable > **new TransportValidationError**(`message`, `methods`): `TransportValidationError` -Defined in: [packages/core/src/TransportValidation.ts:94](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L94) +Defined in: [packages/core/src/TransportValidation.ts:94](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L94) #### Parameters @@ -56,7 +56,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `readonly` **code**: `"CONNECTUM_UNSUPPORTED_STREAMING_TRANSPORT"` = `TRANSPORT_VALIDATION_ERROR_CODE` -Defined in: [packages/core/src/TransportValidation.ts:91](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L91) +Defined in: [packages/core/src/TransportValidation.ts:91](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L91) *** @@ -76,7 +76,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `readonly` **methods**: readonly [`StreamingMethodInfo`](../interfaces/StreamingMethodInfo.md)[] -Defined in: [packages/core/src/TransportValidation.ts:92](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L92) +Defined in: [packages/core/src/TransportValidation.ts:92](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L92) *** diff --git a/en/api/@connectum/core/functions/collectStreamingMethods.md b/en/api/@connectum/core/functions/collectStreamingMethods.md index 98ea074d..34a79b82 100644 --- a/en/api/@connectum/core/functions/collectStreamingMethods.md +++ b/en/api/@connectum/core/functions/collectStreamingMethods.md @@ -4,7 +4,7 @@ > **collectStreamingMethods**(`registry`): [`StreamingMethodInfo`](../interfaces/StreamingMethodInfo.md)[] -Defined in: [packages/core/src/TransportValidation.ts:106](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L106) +Defined in: [packages/core/src/TransportValidation.ts:106](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L106) Collect bidi-streaming methods from a DescFile registry (built during route registration). Client-streaming is NOT collected — the Connect diff --git a/en/api/@connectum/core/functions/createCatalogClient.md b/en/api/@connectum/core/functions/createCatalogClient.md new file mode 100644 index 00000000..c75e64e8 --- /dev/null +++ b/en/api/@connectum/core/functions/createCatalogClient.md @@ -0,0 +1,37 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / createCatalogClient + +# Function: createCatalogClient() + +> **createCatalogClient**(`options`): [`CatalogClient`](../interfaces/CatalogClient.md) + +Defined in: [packages/core/src/catalogClient.ts:108](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L108) + +Build a standalone [CatalogClient](../interfaces/CatalogClient.md) from a [ServiceCatalog](../type-aliases/ServiceCatalog.md) and a +[RemoteResolver](../type-aliases/RemoteResolver.md). + +## Parameters + +### options + +[`CreateCatalogClientOptions`](../interfaces/CreateCatalogClientOptions.md) + +## Returns + +[`CatalogClient`](../interfaces/CatalogClient.md) + +## Example + +```ts +import { createCatalogClient, mapResolver } from "@connectum/core"; +import { serviceCatalog } from "./gen/catalog.ts"; // @connectum/protoc-gen-catalog + +const client = createCatalogClient({ + catalog: serviceCatalog, + resolver: mapResolver({ + "fleet.v1.FleetService": createGrpcTransport({ baseUrl: process.env.FLEET_ADDR }), + }), +}); + +// Fully typed off the generated catalog — same surface as ctx.call: +const trip = await client.call("trip.v1.TripService/StartTrip", { vehicleId }); +``` diff --git a/en/api/@connectum/core/functions/createLocalTransport.md b/en/api/@connectum/core/functions/createLocalTransport.md index 93941087..ed5a6b6f 100644 --- a/en/api/@connectum/core/functions/createLocalTransport.md +++ b/en/api/@connectum/core/functions/createLocalTransport.md @@ -4,7 +4,7 @@ > **createLocalTransport**(`server`, `options?`): `Transport` -Defined in: [packages/core/src/localTransport.ts:104](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/localTransport.ts#L104) +Defined in: [packages/core/src/localTransport.ts:104](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/localTransport.ts#L104) Create an in-process ConnectRPC `Transport` over the services already registered on the given Connectum `Server`. diff --git a/en/api/@connectum/core/functions/createServer.md b/en/api/@connectum/core/functions/createServer.md index 5733e8f2..3966d29f 100644 --- a/en/api/@connectum/core/functions/createServer.md +++ b/en/api/@connectum/core/functions/createServer.md @@ -4,7 +4,7 @@ > **createServer**(`options`): [`Server`](../types/interfaces/Server.md) -Defined in: [packages/core/src/Server.ts:576](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/Server.ts#L576) +Defined in: [packages/core/src/Server.ts:576](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/Server.ts#L576) Create a new server instance diff --git a/en/api/@connectum/core/functions/defineCatalog.md b/en/api/@connectum/core/functions/defineCatalog.md index d313bb05..08dd2566 100644 --- a/en/api/@connectum/core/functions/defineCatalog.md +++ b/en/api/@connectum/core/functions/defineCatalog.md @@ -4,7 +4,7 @@ > **defineCatalog**\<`T`\>(`record`): `Readonly`\<`T`\> -Defined in: [packages/core/src/serviceCatalog.ts:61](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/serviceCatalog.ts#L61) +Defined in: [packages/core/src/serviceCatalog.ts:61](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/serviceCatalog.ts#L61) Build a [ServiceCatalog](../type-aliases/ServiceCatalog.md) from a literal record, preserving the literal key type for downstream inference. Equivalent to writing the record inline, diff --git a/en/api/@connectum/core/functions/defineLazyService.md b/en/api/@connectum/core/functions/defineLazyService.md index 4e180f8c..67b875a4 100644 --- a/en/api/@connectum/core/functions/defineLazyService.md +++ b/en/api/@connectum/core/functions/defineLazyService.md @@ -4,7 +4,7 @@ > **defineLazyService**\<`S`\>(`descriptor`, `factory`, `options?`): [`ServiceDefinition`](../interfaces/ServiceDefinition.md) -Defined in: [packages/core/src/defineService.ts:91](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/defineService.ts#L91) +Defined in: [packages/core/src/defineService.ts:91](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/defineService.ts#L91) Define a service whose handlers (and their dependencies) are created lazily. diff --git a/en/api/@connectum/core/functions/defineService.md b/en/api/@connectum/core/functions/defineService.md index 8ad713c9..02078dda 100644 --- a/en/api/@connectum/core/functions/defineService.md +++ b/en/api/@connectum/core/functions/defineService.md @@ -4,7 +4,7 @@ > **defineService**\<`S`\>(`descriptor`, `handlers`, `options?`): [`ServiceDefinition`](../interfaces/ServiceDefinition.md) -Defined in: [packages/core/src/defineService.ts:74](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/defineService.ts#L74) +Defined in: [packages/core/src/defineService.ts:74](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/defineService.ts#L74) Define a service from its descriptor and handler map. diff --git a/en/api/@connectum/core/functions/dnsResolver.md b/en/api/@connectum/core/functions/dnsResolver.md index dc24d83b..09509ac3 100644 --- a/en/api/@connectum/core/functions/dnsResolver.md +++ b/en/api/@connectum/core/functions/dnsResolver.md @@ -4,7 +4,7 @@ > **dnsResolver**(`options`): [`RemoteResolver`](../type-aliases/RemoteResolver.md) -Defined in: [packages/core/src/remoteResolver.ts:77](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L77) +Defined in: [packages/core/src/remoteResolver.ts:77](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L77) A resolver that derives a base URL per service from a DNS-style template and builds a transport for it. Mirrors typical container/k8s service-name routing. diff --git a/en/api/@connectum/core/functions/getTLSPath.md b/en/api/@connectum/core/functions/getTLSPath.md index 5927e60f..4873bb23 100644 --- a/en/api/@connectum/core/functions/getTLSPath.md +++ b/en/api/@connectum/core/functions/getTLSPath.md @@ -4,7 +4,7 @@ > **getTLSPath**(): `string` -Defined in: [packages/core/src/TLSConfig.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TLSConfig.ts#L20) +Defined in: [packages/core/src/TLSConfig.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TLSConfig.ts#L20) Get TLS directory path diff --git a/en/api/@connectum/core/functions/isSanitizableError.md b/en/api/@connectum/core/functions/isSanitizableError.md index a36c61fd..080a58f1 100644 --- a/en/api/@connectum/core/functions/isSanitizableError.md +++ b/en/api/@connectum/core/functions/isSanitizableError.md @@ -4,7 +4,7 @@ > **isSanitizableError**(`err`): `err is Error & SanitizableError & { code: number }` -Defined in: [packages/core/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/errors.ts#L28) +Defined in: [packages/core/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/errors.ts#L28) Type guard for SanitizableError. diff --git a/en/api/@connectum/core/functions/mapResolver.md b/en/api/@connectum/core/functions/mapResolver.md index 054a1620..e3ab32b0 100644 --- a/en/api/@connectum/core/functions/mapResolver.md +++ b/en/api/@connectum/core/functions/mapResolver.md @@ -4,7 +4,7 @@ > **mapResolver**(`map`): [`RemoteResolver`](../type-aliases/RemoteResolver.md) -Defined in: [packages/core/src/remoteResolver.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L54) +Defined in: [packages/core/src/remoteResolver.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L54) A resolver backed by an explicit `{ [typeName]: Transport }` map. Unknown typeNames resolve to `null` (→ `Code.Unavailable`). diff --git a/en/api/@connectum/core/functions/matchServicesPattern.md b/en/api/@connectum/core/functions/matchServicesPattern.md index 86c5b7ee..b0c71d96 100644 --- a/en/api/@connectum/core/functions/matchServicesPattern.md +++ b/en/api/@connectum/core/functions/matchServicesPattern.md @@ -4,7 +4,7 @@ > **matchServicesPattern**(`pattern`, `names`): `string`[] -Defined in: [packages/core/src/enabledServices.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/enabledServices.ts#L31) +Defined in: [packages/core/src/enabledServices.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/enabledServices.ts#L31) Return the subset of `names` matching a glob `pattern`, where `*` matches any run of characters (including dots). E.g. `"acme.*"` matches diff --git a/en/api/@connectum/core/functions/mergeCatalogs.md b/en/api/@connectum/core/functions/mergeCatalogs.md index 9a0877d4..52e8440e 100644 --- a/en/api/@connectum/core/functions/mergeCatalogs.md +++ b/en/api/@connectum/core/functions/mergeCatalogs.md @@ -4,7 +4,7 @@ > **mergeCatalogs**(...`catalogs`): [`ServiceCatalog`](../type-aliases/ServiceCatalog.md) -Defined in: [packages/core/src/serviceCatalog.ts:79](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/serviceCatalog.ts#L79) +Defined in: [packages/core/src/serviceCatalog.ts:79](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/serviceCatalog.ts#L79) Merge several catalogs into one. diff --git a/en/api/@connectum/core/functions/mergeEnabledServices.md b/en/api/@connectum/core/functions/mergeEnabledServices.md index 3f939785..126a3914 100644 --- a/en/api/@connectum/core/functions/mergeEnabledServices.md +++ b/en/api/@connectum/core/functions/mergeEnabledServices.md @@ -4,7 +4,7 @@ > **mergeEnabledServices**(...`lists`): `string`[] -Defined in: [packages/core/src/enabledServices.ts:58](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/enabledServices.ts#L58) +Defined in: [packages/core/src/enabledServices.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/enabledServices.ts#L58) Merge several `enabledServices` lists, de-duplicating while preserving first-seen order. diff --git a/en/api/@connectum/core/functions/parseEnvConfig.md b/en/api/@connectum/core/functions/parseEnvConfig.md index 3e1d775a..7f8f4ec2 100644 --- a/en/api/@connectum/core/functions/parseEnvConfig.md +++ b/en/api/@connectum/core/functions/parseEnvConfig.md @@ -4,7 +4,7 @@ > **parseEnvConfig**(`env?`): `object` -Defined in: [packages/core/src/config/envSchema.ts:145](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L145) +Defined in: [packages/core/src/config/envSchema.ts:145](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L145) Parse and validate environment configuration diff --git a/en/api/@connectum/core/functions/parseServicesEnv.md b/en/api/@connectum/core/functions/parseServicesEnv.md index 72d18821..88ce096f 100644 --- a/en/api/@connectum/core/functions/parseServicesEnv.md +++ b/en/api/@connectum/core/functions/parseServicesEnv.md @@ -4,7 +4,7 @@ > **parseServicesEnv**(`value`): `string`[] -Defined in: [packages/core/src/enabledServices.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/enabledServices.ts#L18) +Defined in: [packages/core/src/enabledServices.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/enabledServices.ts#L18) Parse a comma-separated env value into a list of proto `typeName`s, trimming whitespace and dropping empty entries. Returns `[]` for an empty/undefined value. diff --git a/en/api/@connectum/core/functions/perServiceEnvResolver.md b/en/api/@connectum/core/functions/perServiceEnvResolver.md index 5302a2a6..6b06a0bb 100644 --- a/en/api/@connectum/core/functions/perServiceEnvResolver.md +++ b/en/api/@connectum/core/functions/perServiceEnvResolver.md @@ -4,7 +4,7 @@ > **perServiceEnvResolver**(`map`, `options?`): [`RemoteResolver`](../type-aliases/RemoteResolver.md) -Defined in: [packages/core/src/remoteResolver.ts:100](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L100) +Defined in: [packages/core/src/remoteResolver.ts:100](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L100) A resolver backed by per-service environment variables: `map` pairs each `typeName` with the name of the env var holding its base URL. A service with diff --git a/en/api/@connectum/core/functions/readTLSCertificates.md b/en/api/@connectum/core/functions/readTLSCertificates.md index a85b643a..68f325e5 100644 --- a/en/api/@connectum/core/functions/readTLSCertificates.md +++ b/en/api/@connectum/core/functions/readTLSCertificates.md @@ -4,7 +4,7 @@ > **readTLSCertificates**(`options?`): `object` -Defined in: [packages/core/src/TLSConfig.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TLSConfig.ts#L36) +Defined in: [packages/core/src/TLSConfig.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TLSConfig.ts#L36) Read TLS certificates from configuration diff --git a/en/api/@connectum/core/functions/resolveEffectiveTransport.md b/en/api/@connectum/core/functions/resolveEffectiveTransport.md index c1c62287..6ce26cb5 100644 --- a/en/api/@connectum/core/functions/resolveEffectiveTransport.md +++ b/en/api/@connectum/core/functions/resolveEffectiveTransport.md @@ -4,7 +4,7 @@ > **resolveEffectiveTransport**(`options`): [`EffectiveTransport`](../type-aliases/EffectiveTransport.md) -Defined in: [packages/core/src/TransportValidation.ts:67](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L67) +Defined in: [packages/core/src/TransportValidation.ts:67](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L67) Resolve the effective transport from the server's TLS and `allowHTTP1` configuration. `allowHTTP1` defaults to `true` (matching TransportManager). diff --git a/en/api/@connectum/core/functions/safeParseEnvConfig.md b/en/api/@connectum/core/functions/safeParseEnvConfig.md index bd7d4253..ccc9b190 100644 --- a/en/api/@connectum/core/functions/safeParseEnvConfig.md +++ b/en/api/@connectum/core/functions/safeParseEnvConfig.md @@ -4,7 +4,7 @@ > **safeParseEnvConfig**(`env?`): `ZodSafeParseResult`\<\{ `GRACEFUL_SHUTDOWN_ENABLED`: `boolean`; `GRACEFUL_SHUTDOWN_TIMEOUT_MS`: `number`; `HTTP_HEALTH_ENABLED`: `boolean`; `HTTP_HEALTH_PATH`: `string`; `LISTEN`: `string`; `LOG_BACKEND`: `"console"` \| `"otel"` \| `"pino"`; `LOG_FORMAT`: `"json"` \| `"pretty"`; `LOG_LEVEL`: `"error"` \| `"warn"` \| `"debug"` \| `"info"`; `NODE_ENV`: `"test"` \| `"production"` \| `"development"`; `OTEL_EXPORTER_OTLP_ENDPOINT?`: `string`; `OTEL_SERVICE_NAME?`: `string`; `PORT`: `number`; \}\> -Defined in: [packages/core/src/config/envSchema.ts:162](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L162) +Defined in: [packages/core/src/config/envSchema.ts:162](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L162) Safely parse environment configuration (returns result object) diff --git a/en/api/@connectum/core/functions/singleTransportResolver.md b/en/api/@connectum/core/functions/singleTransportResolver.md index 1d79622a..d479cee8 100644 --- a/en/api/@connectum/core/functions/singleTransportResolver.md +++ b/en/api/@connectum/core/functions/singleTransportResolver.md @@ -4,7 +4,7 @@ > **singleTransportResolver**(`transport`): [`RemoteResolver`](../type-aliases/RemoteResolver.md) -Defined in: [packages/core/src/remoteResolver.ts:46](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L46) +Defined in: [packages/core/src/remoteResolver.ts:46](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L46) A resolver that routes every remote service to the same `Transport`. Useful for a single upstream (sidecar, gateway) that fronts all remote services. diff --git a/en/api/@connectum/core/index.md b/en/api/@connectum/core/index.md index 8620c5cc..4a99c554 100644 --- a/en/api/@connectum/core/index.md +++ b/en/api/@connectum/core/index.md @@ -15,10 +15,12 @@ ## Interfaces - [BidiStreamHandle](interfaces/BidiStreamHandle.md) +- [CatalogClient](interfaces/CatalogClient.md) - [ClientStreamHandle](interfaces/ClientStreamHandle.md) - [ConnectumCallMap](interfaces/ConnectumCallMap.md) - [ConnectumStreamMap](interfaces/ConnectumStreamMap.md) - [Context](interfaces/Context.md) +- [CreateCatalogClientOptions](interfaces/CreateCatalogClientOptions.md) - [CreateLocalTransportOptions](interfaces/CreateLocalTransportOptions.md) - [DnsResolverOptions](interfaces/DnsResolverOptions.md) - [PerServiceEnvResolverOptions](interfaces/PerServiceEnvResolverOptions.md) @@ -30,6 +32,8 @@ ## Type Aliases - [CallOptions](type-aliases/CallOptions.md) +- [CatalogCall](type-aliases/CatalogCall.md) +- [CatalogStream](type-aliases/CatalogStream.md) - [ConnectumEnv](type-aliases/ConnectumEnv.md) - [ConnectumMethodImpl](type-aliases/ConnectumMethodImpl.md) - [ConnectumServiceImpl](type-aliases/ConnectumServiceImpl.md) @@ -57,6 +61,7 @@ ## Functions - [collectStreamingMethods](functions/collectStreamingMethods.md) +- [createCatalogClient](functions/createCatalogClient.md) - [createLocalTransport](functions/createLocalTransport.md) - [createServer](functions/createServer.md) - [defineCatalog](functions/defineCatalog.md) diff --git a/en/api/@connectum/core/interfaces/BidiStreamHandle.md b/en/api/@connectum/core/interfaces/BidiStreamHandle.md index 9e6ea6f3..f23a538a 100644 --- a/en/api/@connectum/core/interfaces/BidiStreamHandle.md +++ b/en/api/@connectum/core/interfaces/BidiStreamHandle.md @@ -2,7 +2,7 @@ # Interface: BidiStreamHandle\ -Defined in: [packages/core/src/context.ts:84](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L84) +Defined in: [packages/core/src/context.ts:84](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L84) Push handle for a bidi-streaming catalog call: `send()` requests while iterating `responses`; `close()` ends only the request (send) half — the @@ -24,7 +24,7 @@ response half keeps yielding until the server completes. > `readonly` **responses**: `AsyncIterable`\<`Res`\> -Defined in: [packages/core/src/context.ts:90](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L90) +Defined in: [packages/core/src/context.ts:90](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L90) The server's response messages, in order. @@ -34,7 +34,7 @@ The server's response messages, in order. > **close**(): `void` -Defined in: [packages/core/src/context.ts:88](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L88) +Defined in: [packages/core/src/context.ts:88](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L88) End the request (send) half; the response half is unaffected. @@ -48,7 +48,7 @@ End the request (send) half; the response half is unaffected. > **send**(`request`): `void` -Defined in: [packages/core/src/context.ts:86](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L86) +Defined in: [packages/core/src/context.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L86) Enqueue one request message. diff --git a/en/api/@connectum/core/interfaces/CatalogClient.md b/en/api/@connectum/core/interfaces/CatalogClient.md new file mode 100644 index 00000000..37fd2163 --- /dev/null +++ b/en/api/@connectum/core/interfaces/CatalogClient.md @@ -0,0 +1,40 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / CatalogClient + +# Interface: CatalogClient + +Defined in: [packages/core/src/catalogClient.ts:67](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L67) + +A standalone, catalog-typed client. Exposes the SAME `call` (unary) and +`stream` (server/client/bidi) surface as the handler [Context](Context.md), keyed +off [ConnectumCallMap](ConnectumCallMap.md)/[ConnectumStreamMap](ConnectumStreamMap.md), without constructing +a `Server`. + +## Properties + +### call + +> **call**: [`CatalogCall`](../type-aliases/CatalogCall.md) + +Defined in: [packages/core/src/catalogClient.ts:78](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L78) + +Invoke a unary service in the catalog over the resolver-supplied +transport. With no augmentation of [ConnectumCallMap](ConnectumCallMap.md) this is +statically uncallable — exactly as on the handler `ctx`. + +Errors mirror `ctx.call`: no catalog / unknown service / unknown method / +wrong kind → `Code.FailedPrecondition`/`Code.Unimplemented`; resolver +returns `null` → `Code.Unavailable`; resolver throws → `Code.Internal` +(cause preserved). + +*** + +### stream + +> **stream**: [`CatalogStream`](../type-aliases/CatalogStream.md) + +Defined in: [packages/core/src/catalogClient.ts:85](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L85) + +Open a streaming call to a service in the catalog over the +resolver-supplied transport. Returns the same kind-specific factory as +`ctx.stream` (server-streaming → `AsyncIterable`; client-/bidi-streaming → +push handles). diff --git a/en/api/@connectum/core/interfaces/ClientStreamHandle.md b/en/api/@connectum/core/interfaces/ClientStreamHandle.md index c8c1455e..51e2dcf1 100644 --- a/en/api/@connectum/core/interfaces/ClientStreamHandle.md +++ b/en/api/@connectum/core/interfaces/ClientStreamHandle.md @@ -2,7 +2,7 @@ # Interface: ClientStreamHandle\ -Defined in: [packages/core/src/context.ts:72](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L72) +Defined in: [packages/core/src/context.ts:72](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L72) Push handle for a client-streaming catalog call: send N requests, then `close()` to receive the single aggregated response. @@ -23,7 +23,7 @@ Push handle for a client-streaming catalog call: send N requests, then > **close**(): `Promise`\<`Res`\> -Defined in: [packages/core/src/context.ts:76](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L76) +Defined in: [packages/core/src/context.ts:76](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L76) End the request stream and resolve with the server's single response. @@ -37,7 +37,7 @@ End the request stream and resolve with the server's single response. > **send**(`request`): `void` -Defined in: [packages/core/src/context.ts:74](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L74) +Defined in: [packages/core/src/context.ts:74](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L74) Enqueue one request message. diff --git a/en/api/@connectum/core/interfaces/ConnectumCallMap.md b/en/api/@connectum/core/interfaces/ConnectumCallMap.md index a7d152de..be38625b 100644 --- a/en/api/@connectum/core/interfaces/ConnectumCallMap.md +++ b/en/api/@connectum/core/interfaces/ConnectumCallMap.md @@ -2,7 +2,7 @@ # Interface: ConnectumCallMap -Defined in: [packages/core/src/serviceCatalog.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/serviceCatalog.ts#L31) +Defined in: [packages/core/src/serviceCatalog.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/serviceCatalog.ts#L31) Module-augmentation target for type-safe **unary** `ctx.call(method, request)`. @@ -17,7 +17,7 @@ untyped rather than a hard error). > **echo.v1.EchoService/Echo**: `object` -Defined in: [packages/core/tests/integration/ctxCall.test.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxCall.test.ts#L31) +Defined in: [packages/core/tests/integration/catalogClient.test.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L37) #### request @@ -33,7 +33,7 @@ Defined in: [packages/core/tests/integration/ctxCall.test.ts:31](https://github. > **echo.v1.EchoService/Nope**: `object` -Defined in: [packages/core/tests/integration/ctxCall.test.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxCall.test.ts#L34) +Defined in: [packages/core/tests/integration/ctxCall.test.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/ctxCall.test.ts#L34) #### request @@ -49,7 +49,7 @@ Defined in: [packages/core/tests/integration/ctxCall.test.ts:34](https://github. > **echo.v1.EchoService/RateLimitedEcho**: `object` -Defined in: [packages/core/tests/integration/ctxCallErrorTrailers.test.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxCallErrorTrailers.test.ts#L23) +Defined in: [packages/core/tests/integration/ctxCallErrorTrailers.test.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/ctxCallErrorTrailers.test.ts#L23) #### request @@ -65,7 +65,7 @@ Defined in: [packages/core/tests/integration/ctxCallErrorTrailers.test.ts:23](ht > **ghost.v1.GhostService/Vanish**: `object` -Defined in: [packages/core/tests/integration/ctxCall.test.ts:33](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxCall.test.ts#L33) +Defined in: [packages/core/tests/integration/ctxCall.test.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/ctxCall.test.ts#L33) #### request @@ -77,11 +77,43 @@ Defined in: [packages/core/tests/integration/ctxCall.test.ts:33](https://github. *** +### phantom.v1.PhantomService/Vanish + +> **phantom.v1.PhantomService/Vanish**: `object` + +Defined in: [packages/core/tests/integration/catalogClient.test.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L38) + +#### request + +> **request**: `Item` + +#### response + +> **response**: `Item` + +*** + +### streaming.v1.StreamingService/Absent + +> **streaming.v1.StreamingService/Absent**: `object` + +Defined in: [packages/core/tests/integration/catalogClient.test.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L39) + +#### request + +> **request**: `Item` + +#### response + +> **response**: `Item` + +*** + ### streaming.v1.StreamingService/Echo > **streaming.v1.StreamingService/Echo**: `object` -Defined in: [packages/core/tests/integration/ctxCall.test.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxCall.test.ts#L32) +Defined in: [packages/core/tests/integration/catalogClient.test.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L36) #### request diff --git a/en/api/@connectum/core/interfaces/ConnectumStreamMap.md b/en/api/@connectum/core/interfaces/ConnectumStreamMap.md index 6a26060e..2d022604 100644 --- a/en/api/@connectum/core/interfaces/ConnectumStreamMap.md +++ b/en/api/@connectum/core/interfaces/ConnectumStreamMap.md @@ -2,7 +2,7 @@ # Interface: ConnectumStreamMap -Defined in: [packages/core/src/serviceCatalog.ts:42](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/serviceCatalog.ts#L42) +Defined in: [packages/core/src/serviceCatalog.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/serviceCatalog.ts#L42) Module-augmentation target for type-safe **streaming** `ctx.stream(method, ...)`. @@ -17,7 +17,7 @@ Augmented per streaming RPC, keyed `"/"` → > **streaming.v1.StreamingService/Bidi**: `object` -Defined in: [packages/core/tests/integration/ctxStream.test.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxStream.test.ts#L28) +Defined in: [packages/core/tests/integration/catalogClient.test.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L44) #### kind @@ -37,7 +37,7 @@ Defined in: [packages/core/tests/integration/ctxStream.test.ts:28](https://githu > **streaming.v1.StreamingService/Client**: `object` -Defined in: [packages/core/tests/integration/ctxStream.test.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxStream.test.ts#L27) +Defined in: [packages/core/tests/integration/catalogClient.test.ts:43](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L43) #### kind @@ -57,7 +57,7 @@ Defined in: [packages/core/tests/integration/ctxStream.test.ts:27](https://githu > **streaming.v1.StreamingService/Server**: `object` -Defined in: [packages/core/tests/integration/ctxStream.test.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/tests/integration/ctxStream.test.ts#L26) +Defined in: [packages/core/tests/integration/catalogClient.test.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/tests/integration/catalogClient.test.ts#L42) #### kind diff --git a/en/api/@connectum/core/interfaces/Context.md b/en/api/@connectum/core/interfaces/Context.md index 8c2f0206..f742275a 100644 --- a/en/api/@connectum/core/interfaces/Context.md +++ b/en/api/@connectum/core/interfaces/Context.md @@ -2,7 +2,7 @@ # Interface: Context -Defined in: [packages/core/src/context.ts:112](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L112) +Defined in: [packages/core/src/context.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L131) The context object passed to every Connectum service handler. @@ -16,6 +16,27 @@ and adds [Context.call](#call) (unary catalog calls) and [Context.stream](#strea ## Properties +### call + +> **call**: [`CatalogCall`](../type-aliases/CatalogCall.md) + +Defined in: [packages/core/src/context.ts:142](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L142) + +Invoke a unary service in the catalog. The transport is chosen +automatically: an in-process call when the target is mounted locally, +otherwise the `remoteResolver`-supplied transport. + +`signal` and `timeoutMs` cascade from the incoming request unless +overridden in `options` (see [CallOptions](../type-aliases/CallOptions.md)). + +#### Type Param + +**K** + +A `"${typeName}/${Method}"` key of [ConnectumCallMap](ConnectumCallMap.md). + +*** + ### method > `readonly` **method**: `DescMethod` @@ -136,6 +157,28 @@ The signal can be used to automatically cancel downstream calls. *** +### stream + +> **stream**: [`CatalogStream`](../type-aliases/CatalogStream.md) + +Defined in: [packages/core/src/context.ts:155](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L155) + +Open a streaming call to a service in the catalog. Returns a kind-specific +factory: server-streaming yields an `AsyncIterable`; client- and +bidi-streaming return push handles (see [ClientStreamHandle](ClientStreamHandle.md) / +[BidiStreamHandle](BidiStreamHandle.md)). + +On a mid-stream transport failure the iterator delivers the messages +received so far and then throws the terminal `ConnectError`. + +#### Type Param + +**K** + +A `"${typeName}/${Method}"` key of [ConnectumStreamMap](ConnectumStreamMap.md). + +*** + ### timeoutMs > `readonly` **timeoutMs**: () => `number` \| `undefined` @@ -180,78 +223,3 @@ Per RPC context values that can be used to pass data to handlers. #### Inherited from `HandlerContext.values` - -## Methods - -### call() - -> **call**\<`K`\>(`method`, `request`, `options?`): `Promise`\<[`ConnectumCallMap`](ConnectumCallMap.md)\[`K`\]\[`"response"`\]\> - -Defined in: [packages/core/src/context.ts:123](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L123) - -Invoke a unary service in the catalog. The transport is chosen -automatically: an in-process call when the target is mounted locally, -otherwise the `remoteResolver`-supplied transport. - -`signal` and `timeoutMs` cascade from the incoming request unless -overridden in `options` (see [CallOptions](../type-aliases/CallOptions.md)). - -#### Type Parameters - -##### K - -`K` *extends* keyof [`ConnectumCallMap`](ConnectumCallMap.md) - -A `"${typeName}/${Method}"` key of [ConnectumCallMap](ConnectumCallMap.md). - -#### Parameters - -##### method - -`K` - -##### request - -[`ConnectumCallMap`](ConnectumCallMap.md)\[`K`\]\[`"request"`\] - -##### options? - -[`CallOptions`](../type-aliases/CallOptions.md) - -#### Returns - -`Promise`\<[`ConnectumCallMap`](ConnectumCallMap.md)\[`K`\]\[`"response"`\]\> - -*** - -### stream() - -> **stream**\<`K`\>(`method`): [`StreamReturn`](../type-aliases/StreamReturn.md)\<[`ConnectumStreamMap`](ConnectumStreamMap.md)\[`K`\]\> - -Defined in: [packages/core/src/context.ts:136](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L136) - -Open a streaming call to a service in the catalog. Returns a kind-specific -factory: server-streaming yields an `AsyncIterable`; client- and -bidi-streaming return push handles (see [ClientStreamHandle](ClientStreamHandle.md) / -[BidiStreamHandle](BidiStreamHandle.md)). - -On a mid-stream transport failure the iterator delivers the messages -received so far and then throws the terminal `ConnectError`. - -#### Type Parameters - -##### K - -`K` *extends* keyof [`ConnectumStreamMap`](ConnectumStreamMap.md) - -A `"${typeName}/${Method}"` key of [ConnectumStreamMap](ConnectumStreamMap.md). - -#### Parameters - -##### method - -`K` - -#### Returns - -[`StreamReturn`](../type-aliases/StreamReturn.md)\<[`ConnectumStreamMap`](ConnectumStreamMap.md)\[`K`\]\> diff --git a/en/api/@connectum/core/interfaces/CreateCatalogClientOptions.md b/en/api/@connectum/core/interfaces/CreateCatalogClientOptions.md new file mode 100644 index 00000000..713aa0aa --- /dev/null +++ b/en/api/@connectum/core/interfaces/CreateCatalogClientOptions.md @@ -0,0 +1,31 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / CreateCatalogClientOptions + +# Interface: CreateCatalogClientOptions + +Defined in: [packages/core/src/catalogClient.ts:46](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L46) + +Options for [createCatalogClient](../functions/createCatalogClient.md). + +## Properties + +### catalog + +> **catalog**: [`ServiceCatalog`](../type-aliases/ServiceCatalog.md) + +Defined in: [packages/core/src/catalogClient.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L51) + +The service catalog (a `Record`) that backs typed +dispatch — the same object passed to `createServer({ catalog })`. + +*** + +### resolver + +> **resolver**: [`RemoteResolver`](../type-aliases/RemoteResolver.md) + +Defined in: [packages/core/src/catalogClient.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/catalogClient.ts#L58) + +Maps a target service `typeName` to a ConnectRPC `Transport`. Required: +unlike a `Server`, a catalog client has no in-process/local path, so every +call is routed through the resolver. A resolver that returns `null` for a +target makes that call fail with `Code.Unavailable`. diff --git a/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md b/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md index 54c5c837..dd54de57 100644 --- a/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md +++ b/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md @@ -2,7 +2,7 @@ # Interface: CreateLocalTransportOptions -Defined in: [packages/core/src/localTransport.ts:44](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/localTransport.ts#L44) +Defined in: [packages/core/src/localTransport.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/localTransport.ts#L44) Options for [createLocalTransport](../functions/createLocalTransport.md). @@ -12,7 +12,7 @@ Options for [createLocalTransport](../functions/createLocalTransport.md). > `optional` **interceptors?**: `Interceptor`[] -Defined in: [packages/core/src/localTransport.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/localTransport.ts#L51) +Defined in: [packages/core/src/localTransport.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/localTransport.ts#L51) Client-side interceptors applied to outbound calls before they reach the registered handlers. Server-side interceptors configured on the diff --git a/en/api/@connectum/core/interfaces/DnsResolverOptions.md b/en/api/@connectum/core/interfaces/DnsResolverOptions.md index ec56742f..92cf09cb 100644 --- a/en/api/@connectum/core/interfaces/DnsResolverOptions.md +++ b/en/api/@connectum/core/interfaces/DnsResolverOptions.md @@ -2,7 +2,7 @@ # Interface: DnsResolverOptions -Defined in: [packages/core/src/remoteResolver.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L59) +Defined in: [packages/core/src/remoteResolver.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L59) Options for [dnsResolver](../functions/dnsResolver.md). @@ -12,7 +12,7 @@ Options for [dnsResolver](../functions/dnsResolver.md). > `readonly` `optional` **createTransport?**: (`baseUrl`) => `Transport` -Defined in: [packages/core/src/remoteResolver.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L68) +Defined in: [packages/core/src/remoteResolver.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L68) Build a `Transport` from the resolved base URL. Defaults to a gRPC (HTTP/2) transport. @@ -32,7 +32,7 @@ Build a `Transport` from the resolved base URL. Defaults to a gRPC (HTTP/2) tran > `readonly` **template**: `string` -Defined in: [packages/core/src/remoteResolver.ts:66](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L66) +Defined in: [packages/core/src/remoteResolver.ts:66](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L66) URL template with `{shortName}` (alias `{name}`) placeholders. The short name is the last `typeName` segment, lower-cased, minus a trailing diff --git a/en/api/@connectum/core/interfaces/PerServiceEnvResolverOptions.md b/en/api/@connectum/core/interfaces/PerServiceEnvResolverOptions.md index 94649964..41d2a162 100644 --- a/en/api/@connectum/core/interfaces/PerServiceEnvResolverOptions.md +++ b/en/api/@connectum/core/interfaces/PerServiceEnvResolverOptions.md @@ -2,7 +2,7 @@ # Interface: PerServiceEnvResolverOptions -Defined in: [packages/core/src/remoteResolver.ts:87](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L87) +Defined in: [packages/core/src/remoteResolver.ts:87](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L87) Options for [perServiceEnvResolver](../functions/perServiceEnvResolver.md). @@ -12,7 +12,7 @@ Options for [perServiceEnvResolver](../functions/perServiceEnvResolver.md). > `readonly` `optional` **createTransport?**: (`baseUrl`) => `Transport` -Defined in: [packages/core/src/remoteResolver.ts:89](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L89) +Defined in: [packages/core/src/remoteResolver.ts:89](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L89) Build a `Transport` from the resolved base URL. Defaults to a gRPC (HTTP/2) transport. diff --git a/en/api/@connectum/core/interfaces/ResolverContext.md b/en/api/@connectum/core/interfaces/ResolverContext.md index 681964ac..a24e6480 100644 --- a/en/api/@connectum/core/interfaces/ResolverContext.md +++ b/en/api/@connectum/core/interfaces/ResolverContext.md @@ -2,7 +2,7 @@ # Interface: ResolverContext -Defined in: [packages/core/src/remoteResolver.ts:29](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L29) +Defined in: [packages/core/src/remoteResolver.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L29) Context handed to a [RemoteResolver](../type-aliases/RemoteResolver.md) for a single resolution. @@ -12,7 +12,7 @@ Context handed to a [RemoteResolver](../type-aliases/RemoteResolver.md) for a si > `readonly` `optional` **endpoint?**: `string` -Defined in: [packages/core/src/remoteResolver.ts:33](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L33) +Defined in: [packages/core/src/remoteResolver.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L33) Opaque endpoint hint from `CallOptions.endpoint` (polymorphic deployments). @@ -22,6 +22,6 @@ Opaque endpoint hint from `CallOptions.endpoint` (polymorphic deployments). > `readonly` **typeName**: `string` -Defined in: [packages/core/src/remoteResolver.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L31) +Defined in: [packages/core/src/remoteResolver.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L31) Proto service `typeName`, e.g. `"orders.v1.OrdersService"`. diff --git a/en/api/@connectum/core/interfaces/SanitizableError.md b/en/api/@connectum/core/interfaces/SanitizableError.md index 915f8d3a..0674c49d 100644 --- a/en/api/@connectum/core/interfaces/SanitizableError.md +++ b/en/api/@connectum/core/interfaces/SanitizableError.md @@ -2,7 +2,7 @@ # Interface: SanitizableError -Defined in: [packages/core/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/errors.ts#L17) +Defined in: [packages/core/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/errors.ts#L17) Sanitizable error interface. @@ -15,7 +15,7 @@ but expose only a safe message to clients. > `readonly` **clientMessage**: `string` -Defined in: [packages/core/src/errors.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/errors.ts#L18) +Defined in: [packages/core/src/errors.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/errors.ts#L18) *** @@ -23,4 +23,4 @@ Defined in: [packages/core/src/errors.ts:18](https://github.com/Connectum-Framew > `readonly` **serverDetails**: `Readonly`\<`Record`\<`string`, `unknown`\>\> -Defined in: [packages/core/src/errors.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/errors.ts#L19) +Defined in: [packages/core/src/errors.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/errors.ts#L19) diff --git a/en/api/@connectum/core/interfaces/ServiceDefinition.md b/en/api/@connectum/core/interfaces/ServiceDefinition.md index 774ea157..2711a3be 100644 --- a/en/api/@connectum/core/interfaces/ServiceDefinition.md +++ b/en/api/@connectum/core/interfaces/ServiceDefinition.md @@ -2,7 +2,7 @@ # Interface: ServiceDefinition -Defined in: [packages/core/src/defineService.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/defineService.ts#L50) +Defined in: [packages/core/src/defineService.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/defineService.ts#L50) A service ready to be mounted: its proto descriptor plus a `register` closure that wires the handlers onto a `ConnectRouter`. Produced by [defineService](../functions/defineService.md) @@ -14,7 +14,7 @@ and [defineLazyService](../functions/defineLazyService.md); consumed by `createS > `readonly` **descriptor**: `DescService` -Defined in: [packages/core/src/defineService.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/defineService.ts#L52) +Defined in: [packages/core/src/defineService.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/defineService.ts#L52) The proto service descriptor (carries `typeName` and `file`). @@ -24,7 +24,7 @@ The proto service descriptor (carries `typeName` and `file`). > `readonly` **register**: (`router`, `ctx`) => `void` -Defined in: [packages/core/src/defineService.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/defineService.ts#L54) +Defined in: [packages/core/src/defineService.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/defineService.ts#L54) **`Internal`** diff --git a/en/api/@connectum/core/interfaces/StreamingMethodInfo.md b/en/api/@connectum/core/interfaces/StreamingMethodInfo.md index 7db3d0eb..cfa81e99 100644 --- a/en/api/@connectum/core/interfaces/StreamingMethodInfo.md +++ b/en/api/@connectum/core/interfaces/StreamingMethodInfo.md @@ -2,7 +2,7 @@ # Interface: StreamingMethodInfo -Defined in: [packages/core/src/TransportValidation.ts:76](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L76) +Defined in: [packages/core/src/TransportValidation.ts:76](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L76) A streaming method that requires HTTP/2. @@ -12,7 +12,7 @@ A streaming method that requires HTTP/2. > `readonly` **kind**: `string` -Defined in: [packages/core/src/TransportValidation.ts:82](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L82) +Defined in: [packages/core/src/TransportValidation.ts:82](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L82) Streaming kind: `bidi_streaming`. @@ -22,7 +22,7 @@ Streaming kind: `bidi_streaming`. > `readonly` **method**: `string` -Defined in: [packages/core/src/TransportValidation.ts:80](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L80) +Defined in: [packages/core/src/TransportValidation.ts:80](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L80) Method name (e.g. `StreamCodes`). @@ -32,6 +32,6 @@ Method name (e.g. `StreamCodes`). > `readonly` **service**: `string` -Defined in: [packages/core/src/TransportValidation.ts:78](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L78) +Defined in: [packages/core/src/TransportValidation.ts:78](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L78) Fully qualified service typeName (e.g. `acme.v1.ScannerService`). diff --git a/en/api/@connectum/core/type-aliases/CallOptions.md b/en/api/@connectum/core/type-aliases/CallOptions.md index fc2a052b..20997284 100644 --- a/en/api/@connectum/core/type-aliases/CallOptions.md +++ b/en/api/@connectum/core/type-aliases/CallOptions.md @@ -4,7 +4,7 @@ > **CallOptions** = `object` -Defined in: [packages/core/src/context.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L40) +Defined in: [packages/core/src/context.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L40) Per-call overrides for [Context.call](../interfaces/Context.md#call). @@ -19,7 +19,7 @@ Connectum catalog `CallOptions`, intentionally distinct from > `optional` **endpoint?**: `string` -Defined in: [packages/core/src/context.ts:65](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L65) +Defined in: [packages/core/src/context.ts:65](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L65) Opaque endpoint hint forwarded to the configured `remoteResolver` for services reachable at several endpoints. Ignored for locally-mounted @@ -31,7 +31,7 @@ services. > `optional` **headers?**: `HeadersInit` -Defined in: [packages/core/src/context.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L59) +Defined in: [packages/core/src/context.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L59) Extra request headers. Only these explicit headers are sent; no inbound headers are auto-propagated (trace context flows implicitly via the OTel @@ -43,7 +43,7 @@ client interceptor in `outgoingInterceptors`). > `optional` **signal?**: `AbortSignal` -Defined in: [packages/core/src/context.ts:47](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L47) +Defined in: [packages/core/src/context.ts:47](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L47) Abort signal for the outgoing call. When omitted, the incoming request's `ctx.signal` is injected, so cancelling the inbound RPC cancels every @@ -56,7 +56,7 @@ not linked with `ctx.signal`). > `optional` **timeoutMs?**: `number` -Defined in: [packages/core/src/context.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L53) +Defined in: [packages/core/src/context.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L53) Timeout in milliseconds. When omitted, the remaining inbound deadline (`ctx.timeoutMs()`) is injected. A caller may **shorten** the deadline, diff --git a/en/api/@connectum/core/type-aliases/CatalogCall.md b/en/api/@connectum/core/type-aliases/CatalogCall.md new file mode 100644 index 00000000..46174178 --- /dev/null +++ b/en/api/@connectum/core/type-aliases/CatalogCall.md @@ -0,0 +1,38 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / CatalogCall + +# Type Alias: CatalogCall + +> **CatalogCall** = \<`K`\>(`method`, `request`, `options?`) => `Promise`\<[`ConnectumCallMap`](../interfaces/ConnectumCallMap.md)\[`K`\]\[`"response"`\]\> + +Defined in: [packages/core/src/context.ts:113](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L113) + +The typed **unary** catalog-call surface: `call(method, request, options?)` +keyed off [ConnectumCallMap](../interfaces/ConnectumCallMap.md). Shared by the handler [Context](../interfaces/Context.md) and +the standalone `CatalogClient` (`createCatalogClient`) so both expose an +identical, fully-typed `call`. + +## Type Parameters + +### K + +`K` *extends* keyof [`ConnectumCallMap`](../interfaces/ConnectumCallMap.md) + +A `"${typeName}/${Method}"` key of [ConnectumCallMap](../interfaces/ConnectumCallMap.md). + +## Parameters + +### method + +`K` + +### request + +[`ConnectumCallMap`](../interfaces/ConnectumCallMap.md)\[`K`\]\[`"request"`\] + +### options? + +[`CallOptions`](CallOptions.md) + +## Returns + +`Promise`\<[`ConnectumCallMap`](../interfaces/ConnectumCallMap.md)\[`K`\]\[`"response"`\]\> diff --git a/en/api/@connectum/core/type-aliases/CatalogStream.md b/en/api/@connectum/core/type-aliases/CatalogStream.md new file mode 100644 index 00000000..ae194ce2 --- /dev/null +++ b/en/api/@connectum/core/type-aliases/CatalogStream.md @@ -0,0 +1,29 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / CatalogStream + +# Type Alias: CatalogStream + +> **CatalogStream** = \<`K`\>(`method`) => [`StreamReturn`](StreamReturn.md)\<[`ConnectumStreamMap`](../interfaces/ConnectumStreamMap.md)\[`K`\]\> + +Defined in: [packages/core/src/context.ts:122](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L122) + +The typed **streaming** catalog-call surface: `stream(method)` returns a +kind-specific factory keyed off [ConnectumStreamMap](../interfaces/ConnectumStreamMap.md). Shared by the +handler [Context](../interfaces/Context.md) and the standalone `CatalogClient`. + +## Type Parameters + +### K + +`K` *extends* keyof [`ConnectumStreamMap`](../interfaces/ConnectumStreamMap.md) + +A `"${typeName}/${Method}"` key of [ConnectumStreamMap](../interfaces/ConnectumStreamMap.md). + +## Parameters + +### method + +`K` + +## Returns + +[`StreamReturn`](StreamReturn.md)\<[`ConnectumStreamMap`](../interfaces/ConnectumStreamMap.md)\[`K`\]\> diff --git a/en/api/@connectum/core/type-aliases/ConnectumEnv.md b/en/api/@connectum/core/type-aliases/ConnectumEnv.md index ce29562e..73248ffa 100644 --- a/en/api/@connectum/core/type-aliases/ConnectumEnv.md +++ b/en/api/@connectum/core/type-aliases/ConnectumEnv.md @@ -4,6 +4,6 @@ > **ConnectumEnv** = `z.infer`\<*typeof* [`ConnectumEnvSchema`](../variables/ConnectumEnvSchema.md)\> -Defined in: [packages/core/src/config/envSchema.ts:133](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L133) +Defined in: [packages/core/src/config/envSchema.ts:133](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L133) Connectum environment configuration type diff --git a/en/api/@connectum/core/type-aliases/ConnectumMethodImpl.md b/en/api/@connectum/core/type-aliases/ConnectumMethodImpl.md index 218ed155..46930930 100644 --- a/en/api/@connectum/core/type-aliases/ConnectumMethodImpl.md +++ b/en/api/@connectum/core/type-aliases/ConnectumMethodImpl.md @@ -4,7 +4,7 @@ > **ConnectumMethodImpl**\<`M`\> = `M` *extends* `DescMethodUnary`\ ? (`request`, `context`) => `Promise`\<`MessageInitShape`\<`O`\>\> \| `MessageInitShape`\<`O`\> : `M` *extends* `DescMethodServerStreaming`\ ? (`request`, `context`) => `AsyncIterable`\<`MessageInitShape`\<`O`\>\> : `M` *extends* `DescMethodClientStreaming`\ ? (`requests`, `context`) => `Promise`\<`MessageInitShape`\<`O`\>\> : `M` *extends* `DescMethodBiDiStreaming`\ ? (`requests`, `context`) => `AsyncIterable`\<`MessageInitShape`\<`O`\>\> : `never` -Defined in: [packages/core/src/context.ts:145](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L145) +Defined in: [packages/core/src/context.ts:164](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L164) The implementation of a single RPC, receiving a Connectum [Context](../interfaces/Context.md). diff --git a/en/api/@connectum/core/type-aliases/ConnectumServiceImpl.md b/en/api/@connectum/core/type-aliases/ConnectumServiceImpl.md index 72bc8b38..b21e8afa 100644 --- a/en/api/@connectum/core/type-aliases/ConnectumServiceImpl.md +++ b/en/api/@connectum/core/type-aliases/ConnectumServiceImpl.md @@ -4,7 +4,7 @@ > **ConnectumServiceImpl**\<`Desc`\> = `{ [P in keyof Desc["method"]]: ConnectumMethodImpl }` -Defined in: [packages/core/src/context.ts:163](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L163) +Defined in: [packages/core/src/context.ts:182](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L182) The full implementation of a service: one [ConnectumMethodImpl](ConnectumMethodImpl.md) per method. Accepted by [defineService](../functions/defineService.md) / [defineLazyService](../functions/defineLazyService.md). diff --git a/en/api/@connectum/core/type-aliases/EffectiveTransport.md b/en/api/@connectum/core/type-aliases/EffectiveTransport.md index f80cab62..cafc8ba4 100644 --- a/en/api/@connectum/core/type-aliases/EffectiveTransport.md +++ b/en/api/@connectum/core/type-aliases/EffectiveTransport.md @@ -4,7 +4,7 @@ > **EffectiveTransport** = *typeof* [`EffectiveTransport`](../variables/EffectiveTransport.md)\[keyof *typeof* [`EffectiveTransport`](../variables/EffectiveTransport.md)\] -Defined in: [packages/core/src/TransportValidation.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L54) +Defined in: [packages/core/src/TransportValidation.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L54) Effective transport resolved from `tls` + `allowHTTP1`. diff --git a/en/api/@connectum/core/type-aliases/RemoteResolver.md b/en/api/@connectum/core/type-aliases/RemoteResolver.md index 3427647c..87f00f33 100644 --- a/en/api/@connectum/core/type-aliases/RemoteResolver.md +++ b/en/api/@connectum/core/type-aliases/RemoteResolver.md @@ -4,7 +4,7 @@ > **RemoteResolver** = (`ctx`) => `Transport` \| `null` -Defined in: [packages/core/src/remoteResolver.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/remoteResolver.ts#L40) +Defined in: [packages/core/src/remoteResolver.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/remoteResolver.ts#L40) Resolve a remote service to a `Transport`, or `null` if there is no route. Synchronous by contract — see the module note. diff --git a/en/api/@connectum/core/type-aliases/ServiceCatalog.md b/en/api/@connectum/core/type-aliases/ServiceCatalog.md index f286d750..a5491e48 100644 --- a/en/api/@connectum/core/type-aliases/ServiceCatalog.md +++ b/en/api/@connectum/core/type-aliases/ServiceCatalog.md @@ -4,7 +4,7 @@ > **ServiceCatalog** = `Readonly`\<`Record`\<`string`, `DescService`\>\> -Defined in: [packages/core/src/serviceCatalog.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/serviceCatalog.ts#L20) +Defined in: [packages/core/src/serviceCatalog.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/serviceCatalog.ts#L20) A readonly registry mapping a proto service `typeName` (e.g. `"orders.v1.OrdersService"`) to its `DescService` descriptor. diff --git a/en/api/@connectum/core/type-aliases/ServiceOptions.md b/en/api/@connectum/core/type-aliases/ServiceOptions.md index 27b17703..b257d7de 100644 --- a/en/api/@connectum/core/type-aliases/ServiceOptions.md +++ b/en/api/@connectum/core/type-aliases/ServiceOptions.md @@ -4,7 +4,7 @@ > **ServiceOptions** = `NonNullable`\<`Parameters`\<`ConnectRouter`\[`"service"`\]\>\[`2`\]\> -Defined in: [packages/core/src/defineService.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/defineService.ts#L28) +Defined in: [packages/core/src/defineService.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/defineService.ts#L28) Per-service handler options forwarded to ConnectRPC's `router.service()` — e.g. per-service `interceptors` (applied to every method of this service) and diff --git a/en/api/@connectum/core/type-aliases/StreamReturn.md b/en/api/@connectum/core/type-aliases/StreamReturn.md index e378f9e3..209ee279 100644 --- a/en/api/@connectum/core/type-aliases/StreamReturn.md +++ b/en/api/@connectum/core/type-aliases/StreamReturn.md @@ -4,7 +4,7 @@ > **StreamReturn**\<`E`\> = `E` *extends* `object` ? (`request`, `options?`) => `AsyncIterable`\<`Res`\> : `E` *extends* `object` ? (`options?`) => [`ClientStreamHandle`](../interfaces/ClientStreamHandle.md)\<`Req`, `Res`\> : `E` *extends* `object` ? (`options?`) => [`BidiStreamHandle`](../interfaces/BidiStreamHandle.md)\<`Req`, `Res`\> : `never` -Defined in: [packages/core/src/context.ts:97](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/context.ts#L97) +Defined in: [packages/core/src/context.ts:97](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/context.ts#L97) Maps a [ConnectumStreamMap](../interfaces/ConnectumStreamMap.md) entry to the ergonomic shape returned by [Context.stream](../interfaces/Context.md#stream), discriminated by the entry's `kind`. diff --git a/en/api/@connectum/core/type-aliases/TransportValidationMode.md b/en/api/@connectum/core/type-aliases/TransportValidationMode.md index 08233203..7d9a951a 100644 --- a/en/api/@connectum/core/type-aliases/TransportValidationMode.md +++ b/en/api/@connectum/core/type-aliases/TransportValidationMode.md @@ -4,6 +4,6 @@ > **TransportValidationMode** = *typeof* [`TransportValidationMode`](../variables/TransportValidationMode.md)\[keyof *typeof* [`TransportValidationMode`](../variables/TransportValidationMode.md)\] -Defined in: [packages/core/src/TransportValidation.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L37) +Defined in: [packages/core/src/TransportValidation.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L37) Validation severity. diff --git a/en/api/@connectum/core/types/interfaces/CreateServerOptions.md b/en/api/@connectum/core/types/interfaces/CreateServerOptions.md index b9d4b1d4..dcc5f9ce 100644 --- a/en/api/@connectum/core/types/interfaces/CreateServerOptions.md +++ b/en/api/@connectum/core/types/interfaces/CreateServerOptions.md @@ -2,7 +2,7 @@ # Interface: CreateServerOptions -Defined in: [packages/core/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L215) +Defined in: [packages/core/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L215) Server configuration options for createServer() @@ -12,7 +12,7 @@ Server configuration options for createServer() > `optional` **allowHTTP1?**: `boolean` -Defined in: [packages/core/src/types.ts:299](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L299) +Defined in: [packages/core/src/types.ts:299](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L299) Allow HTTP/1.1 connections. @@ -32,7 +32,7 @@ true > `optional` **catalog?**: `Readonly`\<`Record`\<`string`, `DescService`\>\> -Defined in: [packages/core/src/types.ts:368](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L368) +Defined in: [packages/core/src/types.ts:368](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L368) The full set of services known to the system, `typeName → DescService` (typically the generated `serviceCatalog`). Drives startup validation and @@ -45,7 +45,7 @@ makes no cross-service calls needs no catalog. > `optional` **enabledServices?**: readonly `string`[] -Defined in: [packages/core/src/types.ts:376](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L376) +Defined in: [packages/core/src/types.ts:376](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L376) Proto `typeName`s to mount **locally** from `services`. A service in `services` whose `typeName` is not listed is treated as remote (resolved @@ -58,7 +58,7 @@ provided service locally. > `optional` **eventBus?**: [`EventBusLike`](EventBusLike.md) -Defined in: [packages/core/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L288) +Defined in: [packages/core/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L288) Event bus instance for pub/sub messaging. @@ -88,7 +88,7 @@ const server = createServer({ > `optional` **handshakeTimeout?**: `number` -Defined in: [packages/core/src/types.ts:327](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L327) +Defined in: [packages/core/src/types.ts:327](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L327) Handshake timeout in milliseconds @@ -104,7 +104,7 @@ Handshake timeout in milliseconds > `optional` **host?**: `string` -Defined in: [packages/core/src/types.ts:231](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L231) +Defined in: [packages/core/src/types.ts:231](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L231) Server host to bind @@ -120,7 +120,7 @@ Server host to bind > `optional` **http2Options?**: `SecureServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`, *typeof* `Http2ServerRequest`, *typeof* `Http2ServerResponse`\> -Defined in: [packages/core/src/types.ts:332](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L332) +Defined in: [packages/core/src/types.ts:332](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L332) Additional HTTP/2 server options @@ -130,7 +130,7 @@ Additional HTTP/2 server options > `optional` **interceptors?**: `Interceptor`[] -Defined in: [packages/core/src/types.ts:264](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L264) +Defined in: [packages/core/src/types.ts:264](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L264) ConnectRPC interceptors. When omitted or `[]`, no interceptors are applied. @@ -142,7 +142,7 @@ Use `createDefaultInterceptors()` from `@connectum/interceptors` to get the defa > `optional` **jsonOptions?**: `Partial`\<`JsonReadOptions` & `JsonWriteOptions`\> -Defined in: [packages/core/src/types.ts:358](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L358) +Defined in: [packages/core/src/types.ts:358](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L358) Connect JSON serialization options applied server-wide. @@ -174,7 +174,7 @@ const server = createServer({ > `optional` **outgoingInterceptors?**: readonly `Interceptor`[] -Defined in: [packages/core/src/types.ts:390](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L390) +Defined in: [packages/core/src/types.ts:390](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L390) Client-side interceptors applied to every outgoing `server.client()` / `ctx.call` call (cross-cutting concerns like auth or logging), so call @@ -186,7 +186,7 @@ sites stay free of boilerplate. > `optional` **port?**: `number` -Defined in: [packages/core/src/types.ts:225](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L225) +Defined in: [packages/core/src/types.ts:225](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L225) Server port @@ -202,7 +202,7 @@ Server port > `optional` **propagateHeaders?**: readonly `string`[] -Defined in: [packages/core/src/types.ts:400](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L400) +Defined in: [packages/core/src/types.ts:400](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L400) Inbound header names to copy onto every outgoing `ctx.call` / `ctx.stream`. Empty by default — no header is propagated implicitly. Explicit @@ -217,7 +217,7 @@ and add your own, e.g. `[...defaultPropagateHeaders, "x-tenant-id"]`. > `optional` **protocols?**: [`ProtocolRegistration`](ProtocolRegistration.md)[] -Defined in: [packages/core/src/types.ts:252](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L252) +Defined in: [packages/core/src/types.ts:252](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L252) Protocol registrations (healthcheck, reflection, custom) @@ -239,7 +239,7 @@ const server = createServer({ > `optional` **remoteResolver?**: [`RemoteResolver`](../../type-aliases/RemoteResolver.md) -Defined in: [packages/core/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L383) +Defined in: [packages/core/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L383) Resolves a service that is not mounted locally to a `Transport`. Consulted by `server.client()` (and `ctx.call`) for remote services. Synchronous and @@ -251,7 +251,7 @@ must not perform network I/O — see [RemoteResolver](../../type-aliases/RemoteR > **services**: readonly [`ServiceDefinition`](../../interfaces/ServiceDefinition.md)[] -Defined in: [packages/core/src/types.ts:219](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L219) +Defined in: [packages/core/src/types.ts:219](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L219) Service routes to register @@ -261,7 +261,7 @@ Service routes to register > `optional` **shutdown?**: [`ShutdownOptions`](ShutdownOptions.md) -Defined in: [packages/core/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L257) +Defined in: [packages/core/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L257) Graceful shutdown configuration @@ -271,7 +271,7 @@ Graceful shutdown configuration > `optional` **tls?**: [`TLSOptions`](TLSOptions.md) -Defined in: [packages/core/src/types.ts:236](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L236) +Defined in: [packages/core/src/types.ts:236](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L236) TLS configuration @@ -281,7 +281,7 @@ TLS configuration > `optional` **transportValidation?**: `"error"` \| `"warn"` \| `"off"` -Defined in: [packages/core/src/types.ts:321](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L321) +Defined in: [packages/core/src/types.ts:321](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L321) Startup validation of streaming method kinds vs the effective transport. diff --git a/en/api/@connectum/core/types/interfaces/EventBusLike.md b/en/api/@connectum/core/types/interfaces/EventBusLike.md index 71aeaafe..883aca04 100644 --- a/en/api/@connectum/core/types/interfaces/EventBusLike.md +++ b/en/api/@connectum/core/types/interfaces/EventBusLike.md @@ -2,7 +2,7 @@ # Interface: EventBusLike -Defined in: [packages/core/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L127) +Defined in: [packages/core/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L127) Minimal interface for event bus lifecycle integration with the server. @@ -15,7 +15,7 @@ must satisfy this interface to be used with `createServer({ eventBus })`. > **start**(`options?`): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:134](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L134) +Defined in: [packages/core/src/types.ts:134](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L134) Start the event bus (connect to broker, set up subscriptions). @@ -41,7 +41,7 @@ Abort signal from server for graceful shutdown > **stop**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:136](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L136) +Defined in: [packages/core/src/types.ts:136](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L136) Stop the event bus (drain subscriptions, disconnect) diff --git a/en/api/@connectum/core/types/interfaces/ProtocolContext.md b/en/api/@connectum/core/types/interfaces/ProtocolContext.md index 55c7bf35..e564b7d9 100644 --- a/en/api/@connectum/core/types/interfaces/ProtocolContext.md +++ b/en/api/@connectum/core/types/interfaces/ProtocolContext.md @@ -2,7 +2,7 @@ # Interface: ProtocolContext -Defined in: [packages/core/src/types.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L52) +Defined in: [packages/core/src/types.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L52) Context provided to protocol registration functions @@ -15,6 +15,6 @@ may need (e.g., reflection needs DescFile[], healthcheck needs service names). > `readonly` **registry**: readonly `DescFile`[] -Defined in: [packages/core/src/types.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L54) +Defined in: [packages/core/src/types.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L54) Registered service file descriptors diff --git a/en/api/@connectum/core/types/interfaces/ProtocolRegistration.md b/en/api/@connectum/core/types/interfaces/ProtocolRegistration.md index 01706346..1e02de35 100644 --- a/en/api/@connectum/core/types/interfaces/ProtocolRegistration.md +++ b/en/api/@connectum/core/types/interfaces/ProtocolRegistration.md @@ -2,7 +2,7 @@ # Interface: ProtocolRegistration -Defined in: [packages/core/src/types.ts:85](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L85) +Defined in: [packages/core/src/types.ts:85](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L85) Protocol registration interface @@ -31,7 +31,7 @@ const server = createServer({ > `optional` **httpHandler?**: [`HttpHandler`](../type-aliases/HttpHandler.md) -Defined in: [packages/core/src/types.ts:93](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L93) +Defined in: [packages/core/src/types.ts:93](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L93) Optional HTTP handler for fallback routing (e.g., /healthz endpoint) @@ -41,7 +41,7 @@ Optional HTTP handler for fallback routing (e.g., /healthz endpoint) > `readonly` **name**: `string` -Defined in: [packages/core/src/types.ts:87](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L87) +Defined in: [packages/core/src/types.ts:87](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L87) Protocol name for identification (e.g., "healthcheck", "reflection") @@ -51,7 +51,7 @@ Protocol name for identification (e.g., "healthcheck", "reflection") > **register**(`router`, `context`): `void` -Defined in: [packages/core/src/types.ts:90](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L90) +Defined in: [packages/core/src/types.ts:90](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L90) Register protocol services on the router diff --git a/en/api/@connectum/core/types/interfaces/Server.md b/en/api/@connectum/core/types/interfaces/Server.md index 8763f3ed..d9935495 100644 --- a/en/api/@connectum/core/types/interfaces/Server.md +++ b/en/api/@connectum/core/types/interfaces/Server.md @@ -2,7 +2,7 @@ # Interface: Server -Defined in: [packages/core/src/types.ts:424](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L424) +Defined in: [packages/core/src/types.ts:424](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L424) Server interface with explicit lifecycle control @@ -35,7 +35,7 @@ await server.stop(); > `readonly` **address**: `AddressInfo` \| `null` -Defined in: [packages/core/src/types.ts:452](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L452) +Defined in: [packages/core/src/types.ts:452](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L452) Current server address @@ -47,7 +47,7 @@ Returns null until server is started > `readonly` **eventBus**: [`EventBusLike`](EventBusLike.md) \| `null` -Defined in: [packages/core/src/types.ts:592](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L592) +Defined in: [packages/core/src/types.ts:592](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L592) Event bus instance, if configured @@ -59,7 +59,7 @@ Returns null if no event bus was provided to createServer(). > `readonly` **interceptors**: readonly `Interceptor`[] -Defined in: [packages/core/src/types.ts:580](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L580) +Defined in: [packages/core/src/types.ts:580](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L580) Registered interceptors @@ -69,7 +69,7 @@ Registered interceptors > `readonly` **isRunning**: `boolean` -Defined in: [packages/core/src/types.ts:457](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L457) +Defined in: [packages/core/src/types.ts:457](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L457) Whether server is currently running @@ -79,7 +79,7 @@ Whether server is currently running > `readonly` **protocols**: readonly [`ProtocolRegistration`](ProtocolRegistration.md)[] -Defined in: [packages/core/src/types.ts:585](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L585) +Defined in: [packages/core/src/types.ts:585](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L585) Registered protocols @@ -89,7 +89,7 @@ Registered protocols > `readonly` **routes**: readonly [`ServiceDefinition`](../../interfaces/ServiceDefinition.md)[] -Defined in: [packages/core/src/types.ts:575](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L575) +Defined in: [packages/core/src/types.ts:575](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L575) Registered service routes @@ -99,7 +99,7 @@ Registered service routes > `readonly` **shutdownSignal**: `AbortSignal` -Defined in: [packages/core/src/types.ts:559](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L559) +Defined in: [packages/core/src/types.ts:559](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L559) Abort signal that is aborted when server begins shutdown. @@ -112,7 +112,7 @@ that the server is shutting down. > `readonly` **state**: [`ServerState`](../type-aliases/ServerState.md) -Defined in: [packages/core/src/types.ts:462](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L462) +Defined in: [packages/core/src/types.ts:462](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L462) Current server state @@ -122,7 +122,7 @@ Current server state > `readonly` **transport**: [`TransportServer`](../type-aliases/TransportServer.md) \| `null` -Defined in: [packages/core/src/types.ts:570](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L570) +Defined in: [packages/core/src/types.ts:570](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L570) Underlying transport server @@ -193,7 +193,7 @@ v13.4.0, v12.16.0 > **addInterceptor**(`interceptor`): `void` -Defined in: [packages/core/src/types.ts:511](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L511) +Defined in: [packages/core/src/types.ts:511](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L511) Add an interceptor at runtime @@ -255,7 +255,7 @@ v0.1.26 > **addProtocol**(`protocol`): `void` -Defined in: [packages/core/src/types.ts:518](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L518) +Defined in: [packages/core/src/types.ts:518](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L518) Add a protocol at runtime @@ -279,7 +279,7 @@ Error if server is already running > **addService**(`service`): `void` -Defined in: [packages/core/src/types.ts:504](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L504) +Defined in: [packages/core/src/types.ts:504](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L504) Add a service route at runtime @@ -303,7 +303,7 @@ Error if server is already running > **client**\<`T`\>(`service`, `options?`): `Client`\<`T`\> -Defined in: [packages/core/src/types.ts:659](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L659) +Defined in: [packages/core/src/types.ts:659](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L659) Unified client factory: auto-routes to the in-process transport if the service is registered on this `Server`, otherwise to the transport @@ -492,7 +492,7 @@ v1.0.0 > **hasService**(`desc`): `boolean` -Defined in: [packages/core/src/types.ts:632](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L632) +Defined in: [packages/core/src/types.ts:632](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L632) Synchronous registry lookup: returns whether the given proto service descriptor is served locally by this `Server`. Triggers route @@ -611,7 +611,7 @@ v0.1.26 > **localClient**\<`T`\>(`service`): `Client`\<`T`\> -Defined in: [packages/core/src/types.ts:615](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L615) +Defined in: [packages/core/src/types.ts:615](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L615) Create a fully-typed ConnectRPC client that dispatches calls directly to handlers registered on this server, without opening any TCP socket. @@ -654,7 +654,7 @@ const response = await client.sayHello({ name: 'world' }); > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:489](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L489) +Defined in: [packages/core/src/types.ts:489](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L489) Remove listener for lifecycle events @@ -680,7 +680,7 @@ Remove listener for lifecycle events > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:490](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L490) +Defined in: [packages/core/src/types.ts:490](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L490) Alias for `emitter.removeListener()`. @@ -710,7 +710,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:491](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L491) +Defined in: [packages/core/src/types.ts:491](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L491) Alias for `emitter.removeListener()`. @@ -740,7 +740,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:492](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L492) +Defined in: [packages/core/src/types.ts:492](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L492) Alias for `emitter.removeListener()`. @@ -770,7 +770,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:493](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L493) +Defined in: [packages/core/src/types.ts:493](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L493) Alias for `emitter.removeListener()`. @@ -804,7 +804,7 @@ v10.0.0 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:471](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L471) +Defined in: [packages/core/src/types.ts:471](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L471) Register listener for lifecycle events @@ -830,7 +830,7 @@ Register listener for lifecycle events > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:472](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L472) +Defined in: [packages/core/src/types.ts:472](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L472) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -889,7 +889,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:473](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L473) +Defined in: [packages/core/src/types.ts:473](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L473) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -948,7 +948,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:474](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L474) +Defined in: [packages/core/src/types.ts:474](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L474) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1007,7 +1007,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:475](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L475) +Defined in: [packages/core/src/types.ts:475](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L475) Adds the `listener` function to the end of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1070,7 +1070,7 @@ v0.1.101 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:480](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L480) +Defined in: [packages/core/src/types.ts:480](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L480) Register one-time listener for lifecycle events @@ -1096,7 +1096,7 @@ Register one-time listener for lifecycle events > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:481](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L481) +Defined in: [packages/core/src/types.ts:481](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L481) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1152,7 +1152,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:482](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L482) +Defined in: [packages/core/src/types.ts:482](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L482) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1208,7 +1208,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:483](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L483) +Defined in: [packages/core/src/types.ts:483](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L483) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1264,7 +1264,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:484](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L484) +Defined in: [packages/core/src/types.ts:484](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L484) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1324,7 +1324,7 @@ v0.3.0 > **onShutdown**(`handler`): `void` -Defined in: [packages/core/src/types.ts:530](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L530) +Defined in: [packages/core/src/types.ts:530](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L530) Register an anonymous shutdown hook @@ -1348,7 +1348,7 @@ Error if server is already stopped > **onShutdown**(`name`, `handler`): `void` -Defined in: [packages/core/src/types.ts:539](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L539) +Defined in: [packages/core/src/types.ts:539](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L539) Register a named shutdown hook @@ -1378,7 +1378,7 @@ Error if server is already stopped > **onShutdown**(`name`, `dependencies`, `handler`): `void` -Defined in: [packages/core/src/types.ts:551](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L551) +Defined in: [packages/core/src/types.ts:551](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L551) Register a named shutdown hook with dependencies @@ -1778,7 +1778,7 @@ v0.3.5 > **start**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:434](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L434) +Defined in: [packages/core/src/types.ts:434](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L434) Start the server @@ -1796,7 +1796,7 @@ Error if server is not in CREATED state > **stop**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:441](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L441) +Defined in: [packages/core/src/types.ts:441](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L441) Stop the server gracefully diff --git a/en/api/@connectum/core/types/interfaces/ServerClientOptions.md b/en/api/@connectum/core/types/interfaces/ServerClientOptions.md index acda0333..e233fa94 100644 --- a/en/api/@connectum/core/types/interfaces/ServerClientOptions.md +++ b/en/api/@connectum/core/types/interfaces/ServerClientOptions.md @@ -2,7 +2,7 @@ # Interface: ServerClientOptions -Defined in: [packages/core/src/types.ts:665](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L665) +Defined in: [packages/core/src/types.ts:665](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L665) Options for [Server.client](Server.md#client). @@ -12,7 +12,7 @@ Options for [Server.client](Server.md#client). > `optional` **endpoint?**: `string` -Defined in: [packages/core/src/types.ts:671](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L671) +Defined in: [packages/core/src/types.ts:671](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L671) Opaque endpoint hint forwarded to the configured `remoteResolver` when the requested service is not mounted locally (polymorphic deployments — one diff --git a/en/api/@connectum/core/types/interfaces/ShutdownOptions.md b/en/api/@connectum/core/types/interfaces/ShutdownOptions.md index 239c2583..48cfb040 100644 --- a/en/api/@connectum/core/types/interfaces/ShutdownOptions.md +++ b/en/api/@connectum/core/types/interfaces/ShutdownOptions.md @@ -2,7 +2,7 @@ # Interface: ShutdownOptions -Defined in: [packages/core/src/types.ts:184](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L184) +Defined in: [packages/core/src/types.ts:184](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L184) Graceful shutdown options @@ -12,7 +12,7 @@ Graceful shutdown options > `optional` **autoShutdown?**: `boolean` -Defined in: [packages/core/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L201) +Defined in: [packages/core/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L201) Enable automatic graceful shutdown on signals @@ -28,7 +28,7 @@ false > `optional` **forceCloseOnTimeout?**: `boolean` -Defined in: [packages/core/src/types.ts:209](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L209) +Defined in: [packages/core/src/types.ts:209](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L209) Force close all HTTP/2 sessions when shutdown timeout is exceeded. When true, sessions are destroyed after timeout. When false, server @@ -46,7 +46,7 @@ true > `optional` **signals?**: `Signals`[] -Defined in: [packages/core/src/types.ts:195](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L195) +Defined in: [packages/core/src/types.ts:195](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L195) Signals to listen for graceful shutdown @@ -62,7 +62,7 @@ Signals to listen for graceful shutdown > `optional` **timeout?**: `number` -Defined in: [packages/core/src/types.ts:189](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L189) +Defined in: [packages/core/src/types.ts:189](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L189) Timeout in milliseconds for graceful shutdown diff --git a/en/api/@connectum/core/types/interfaces/TLSOptions.md b/en/api/@connectum/core/types/interfaces/TLSOptions.md index e4749761..8aeb2525 100644 --- a/en/api/@connectum/core/types/interfaces/TLSOptions.md +++ b/en/api/@connectum/core/types/interfaces/TLSOptions.md @@ -2,7 +2,7 @@ # Interface: TLSOptions -Defined in: [packages/core/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L99) +Defined in: [packages/core/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L99) TLS configuration options @@ -12,7 +12,7 @@ TLS configuration options > `optional` **certPath?**: `string` -Defined in: [packages/core/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L108) +Defined in: [packages/core/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L108) Path to TLS certificate file @@ -22,7 +22,7 @@ Path to TLS certificate file > `optional` **dirPath?**: `string` -Defined in: [packages/core/src/types.ts:114](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L114) +Defined in: [packages/core/src/types.ts:114](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L114) TLS directory path (alternative to keyPath/certPath) Will look for server.key and server.crt in this directory @@ -33,6 +33,6 @@ Will look for server.key and server.crt in this directory > `optional` **keyPath?**: `string` -Defined in: [packages/core/src/types.ts:103](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L103) +Defined in: [packages/core/src/types.ts:103](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L103) Path to TLS key file diff --git a/en/api/@connectum/core/types/type-aliases/HttpHandler.md b/en/api/@connectum/core/types/type-aliases/HttpHandler.md index 55ad04aa..74c6d8ca 100644 --- a/en/api/@connectum/core/types/type-aliases/HttpHandler.md +++ b/en/api/@connectum/core/types/type-aliases/HttpHandler.md @@ -4,7 +4,7 @@ > **HttpHandler** = (`req`, `res`) => `boolean` -Defined in: [packages/core/src/types.ts:62](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L62) +Defined in: [packages/core/src/types.ts:62](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L62) HTTP handler for protocol-specific endpoints diff --git a/en/api/@connectum/core/types/type-aliases/LifecycleEvent.md b/en/api/@connectum/core/types/type-aliases/LifecycleEvent.md index 886bcdb6..fef590c7 100644 --- a/en/api/@connectum/core/types/type-aliases/LifecycleEvent.md +++ b/en/api/@connectum/core/types/type-aliases/LifecycleEvent.md @@ -4,6 +4,6 @@ > **LifecycleEvent** = *typeof* [`LifecycleEvent`](../variables/LifecycleEvent.md)\[keyof *typeof* [`LifecycleEvent`](../variables/LifecycleEvent.md)\] -Defined in: [packages/core/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L166) +Defined in: [packages/core/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L166) Lifecycle event names diff --git a/en/api/@connectum/core/types/type-aliases/NodeRequest.md b/en/api/@connectum/core/types/type-aliases/NodeRequest.md index 44824fc5..32d1a020 100644 --- a/en/api/@connectum/core/types/type-aliases/NodeRequest.md +++ b/en/api/@connectum/core/types/type-aliases/NodeRequest.md @@ -4,6 +4,6 @@ > **NodeRequest** = `IncomingMessage` \| `Http2ServerRequest` -Defined in: [packages/core/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L22) +Defined in: [packages/core/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L22) Incoming request — HTTP/1.1 or HTTP/2 diff --git a/en/api/@connectum/core/types/type-aliases/NodeResponse.md b/en/api/@connectum/core/types/type-aliases/NodeResponse.md index fa7c4517..e75bef7c 100644 --- a/en/api/@connectum/core/types/type-aliases/NodeResponse.md +++ b/en/api/@connectum/core/types/type-aliases/NodeResponse.md @@ -4,6 +4,6 @@ > **NodeResponse** = `ServerResponse` \| `Http2ServerResponse` -Defined in: [packages/core/src/types.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L25) +Defined in: [packages/core/src/types.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L25) Server response — HTTP/1.1 or HTTP/2 diff --git a/en/api/@connectum/core/types/type-aliases/ServerState.md b/en/api/@connectum/core/types/type-aliases/ServerState.md index 3301d856..e751dd62 100644 --- a/en/api/@connectum/core/types/type-aliases/ServerState.md +++ b/en/api/@connectum/core/types/type-aliases/ServerState.md @@ -4,7 +4,7 @@ > **ServerState** = *typeof* [`ServerState`](../variables/ServerState.md)\[keyof *typeof* [`ServerState`](../variables/ServerState.md)\] -Defined in: [packages/core/src/types.ts:148](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L148) +Defined in: [packages/core/src/types.ts:148](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L148) Server state constants diff --git a/en/api/@connectum/core/types/type-aliases/ShutdownHook.md b/en/api/@connectum/core/types/type-aliases/ShutdownHook.md index 53c08bf9..a1b2866f 100644 --- a/en/api/@connectum/core/types/type-aliases/ShutdownHook.md +++ b/en/api/@connectum/core/types/type-aliases/ShutdownHook.md @@ -4,7 +4,7 @@ > **ShutdownHook** = () => `void` \| `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L40) +Defined in: [packages/core/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L40) Shutdown hook function type diff --git a/en/api/@connectum/core/types/type-aliases/TransportServer.md b/en/api/@connectum/core/types/type-aliases/TransportServer.md index a451cf6e..476b4204 100644 --- a/en/api/@connectum/core/types/type-aliases/TransportServer.md +++ b/en/api/@connectum/core/types/type-aliases/TransportServer.md @@ -4,6 +4,6 @@ > **TransportServer** = `HttpServer` \| `Http2Server` \| `Http2SecureServer` -Defined in: [packages/core/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L28) +Defined in: [packages/core/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L28) Underlying transport server — HTTP/1.1, HTTP/2 plaintext, or HTTP/2 TLS diff --git a/en/api/@connectum/core/types/variables/LifecycleEvent.md b/en/api/@connectum/core/types/variables/LifecycleEvent.md index d41ddab0..327fb382 100644 --- a/en/api/@connectum/core/types/variables/LifecycleEvent.md +++ b/en/api/@connectum/core/types/variables/LifecycleEvent.md @@ -4,7 +4,7 @@ > `const` **LifecycleEvent**: `object` -Defined in: [packages/core/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L166) +Defined in: [packages/core/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L166) Lifecycle event names diff --git a/en/api/@connectum/core/types/variables/ServerState.md b/en/api/@connectum/core/types/variables/ServerState.md index e2197d13..55f5d7c6 100644 --- a/en/api/@connectum/core/types/variables/ServerState.md +++ b/en/api/@connectum/core/types/variables/ServerState.md @@ -4,7 +4,7 @@ > `const` **ServerState**: `object` -Defined in: [packages/core/src/types.ts:148](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/types.ts#L148) +Defined in: [packages/core/src/types.ts:148](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/types.ts#L148) Server state constants diff --git a/en/api/@connectum/core/variables/BooleanFromStringSchema.md b/en/api/@connectum/core/variables/BooleanFromStringSchema.md index b2180317..5e242338 100644 --- a/en/api/@connectum/core/variables/BooleanFromStringSchema.md +++ b/en/api/@connectum/core/variables/BooleanFromStringSchema.md @@ -4,6 +4,6 @@ > `const` **BooleanFromStringSchema**: `ZodPipe`\<`ZodDefault`\<`ZodEnum`\<\{ `0`: `"0"`; `1`: `"1"`; `false`: `"false"`; `no`: `"no"`; `true`: `"true"`; `yes`: `"yes"`; \}\>\>, `ZodTransform`\<`boolean`, `"0"` \| `"1"` \| `"true"` \| `"false"` \| `"yes"` \| `"no"`\>\> -Defined in: [packages/core/src/config/envSchema.ts:35](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L35) +Defined in: [packages/core/src/config/envSchema.ts:35](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L35) Boolean from string schema (for ENV variables) diff --git a/en/api/@connectum/core/variables/ConnectumEnvSchema.md b/en/api/@connectum/core/variables/ConnectumEnvSchema.md index 9aa2eacb..74ae193c 100644 --- a/en/api/@connectum/core/variables/ConnectumEnvSchema.md +++ b/en/api/@connectum/core/variables/ConnectumEnvSchema.md @@ -4,7 +4,7 @@ > `const` **ConnectumEnvSchema**: `ZodObject`\<\{ `GRACEFUL_SHUTDOWN_ENABLED`: `ZodPipe`\<`ZodDefault`\<`ZodEnum`\<\{ `0`: `"0"`; `1`: `"1"`; `false`: `"false"`; `no`: `"no"`; `true`: `"true"`; `yes`: `"yes"`; \}\>\>, `ZodTransform`\<`boolean`, `"0"` \| `"1"` \| `"true"` \| `"false"` \| `"yes"` \| `"no"`\>\>; `GRACEFUL_SHUTDOWN_TIMEOUT_MS`: `ZodDefault`\<`ZodCoercedNumber`\<`unknown`\>\>; `HTTP_HEALTH_ENABLED`: `ZodPipe`\<`ZodDefault`\<`ZodEnum`\<\{ `0`: `"0"`; `1`: `"1"`; `false`: `"false"`; `no`: `"no"`; `true`: `"true"`; `yes`: `"yes"`; \}\>\>, `ZodTransform`\<`boolean`, `"0"` \| `"1"` \| `"true"` \| `"false"` \| `"yes"` \| `"no"`\>\>; `HTTP_HEALTH_PATH`: `ZodDefault`\<`ZodString`\>; `LISTEN`: `ZodDefault`\<`ZodString`\>; `LOG_BACKEND`: `ZodDefault`\<`ZodEnum`\<\{ `console`: `"console"`; `otel`: `"otel"`; `pino`: `"pino"`; \}\>\>; `LOG_FORMAT`: `ZodDefault`\<`ZodEnum`\<\{ `json`: `"json"`; `pretty`: `"pretty"`; \}\>\>; `LOG_LEVEL`: `ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `warn`: `"warn"`; \}\>\>; `NODE_ENV`: `ZodDefault`\<`ZodEnum`\<\{ `development`: `"development"`; `production`: `"production"`; `test`: `"test"`; \}\>\>; `OTEL_EXPORTER_OTLP_ENDPOINT`: `ZodOptional`\<`ZodString`\>; `OTEL_SERVICE_NAME`: `ZodOptional`\<`ZodString`\>; `PORT`: `ZodDefault`\<`ZodCoercedNumber`\<`unknown`\>\>; \}, `$strip`\> -Defined in: [packages/core/src/config/envSchema.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L53) +Defined in: [packages/core/src/config/envSchema.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L53) Connectum environment configuration schema diff --git a/en/api/@connectum/core/variables/EffectiveTransport.md b/en/api/@connectum/core/variables/EffectiveTransport.md index 1c608f08..3d456797 100644 --- a/en/api/@connectum/core/variables/EffectiveTransport.md +++ b/en/api/@connectum/core/variables/EffectiveTransport.md @@ -4,7 +4,7 @@ > `const` **EffectiveTransport**: `object` -Defined in: [packages/core/src/TransportValidation.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L54) +Defined in: [packages/core/src/TransportValidation.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L54) Effective transport resolved from `tls` + `allowHTTP1`. diff --git a/en/api/@connectum/core/variables/LogFormatSchema.md b/en/api/@connectum/core/variables/LogFormatSchema.md index e6314ef8..793f3873 100644 --- a/en/api/@connectum/core/variables/LogFormatSchema.md +++ b/en/api/@connectum/core/variables/LogFormatSchema.md @@ -4,6 +4,6 @@ > `const` **LogFormatSchema**: `ZodDefault`\<`ZodEnum`\<\{ `json`: `"json"`; `pretty`: `"pretty"`; \}\>\> -Defined in: [packages/core/src/config/envSchema.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L20) +Defined in: [packages/core/src/config/envSchema.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L20) Log format schema diff --git a/en/api/@connectum/core/variables/LogLevelSchema.md b/en/api/@connectum/core/variables/LogLevelSchema.md index e2051e67..97aa9197 100644 --- a/en/api/@connectum/core/variables/LogLevelSchema.md +++ b/en/api/@connectum/core/variables/LogLevelSchema.md @@ -4,6 +4,6 @@ > `const` **LogLevelSchema**: `ZodDefault`\<`ZodEnum`\<\{ `debug`: `"debug"`; `error`: `"error"`; `info`: `"info"`; `warn`: `"warn"`; \}\>\> -Defined in: [packages/core/src/config/envSchema.ts:15](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L15) +Defined in: [packages/core/src/config/envSchema.ts:15](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L15) Log level schema with validation diff --git a/en/api/@connectum/core/variables/LoggerBackendSchema.md b/en/api/@connectum/core/variables/LoggerBackendSchema.md index ba7fbaa4..5b9a8fe4 100644 --- a/en/api/@connectum/core/variables/LoggerBackendSchema.md +++ b/en/api/@connectum/core/variables/LoggerBackendSchema.md @@ -4,6 +4,6 @@ > `const` **LoggerBackendSchema**: `ZodDefault`\<`ZodEnum`\<\{ `console`: `"console"`; `otel`: `"otel"`; `pino`: `"pino"`; \}\>\> -Defined in: [packages/core/src/config/envSchema.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L25) +Defined in: [packages/core/src/config/envSchema.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L25) Logger backend schema diff --git a/en/api/@connectum/core/variables/NodeEnvSchema.md b/en/api/@connectum/core/variables/NodeEnvSchema.md index 3e1e79bf..8cdbbf91 100644 --- a/en/api/@connectum/core/variables/NodeEnvSchema.md +++ b/en/api/@connectum/core/variables/NodeEnvSchema.md @@ -4,6 +4,6 @@ > `const` **NodeEnvSchema**: `ZodDefault`\<`ZodEnum`\<\{ `development`: `"development"`; `production`: `"production"`; `test`: `"test"`; \}\>\> -Defined in: [packages/core/src/config/envSchema.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/config/envSchema.ts#L30) +Defined in: [packages/core/src/config/envSchema.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/config/envSchema.ts#L30) Node environment schema diff --git a/en/api/@connectum/core/variables/TRANSPORT_VALIDATION_ERROR_CODE.md b/en/api/@connectum/core/variables/TRANSPORT_VALIDATION_ERROR_CODE.md index c90c01b6..f6f4beb4 100644 --- a/en/api/@connectum/core/variables/TRANSPORT_VALIDATION_ERROR_CODE.md +++ b/en/api/@connectum/core/variables/TRANSPORT_VALIDATION_ERROR_CODE.md @@ -4,7 +4,7 @@ > `const` **TRANSPORT\_VALIDATION\_ERROR\_CODE**: `"CONNECTUM_UNSUPPORTED_STREAMING_TRANSPORT"` = `"CONNECTUM_UNSUPPORTED_STREAMING_TRANSPORT"` -Defined in: [packages/core/src/TransportValidation.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L34) +Defined in: [packages/core/src/TransportValidation.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L34) Stable error code for the streaming-vs-transport startup diagnostic. Searchable in logs and docs. diff --git a/en/api/@connectum/core/variables/TransportValidationMode.md b/en/api/@connectum/core/variables/TransportValidationMode.md index 19ac7c77..95f2090e 100644 --- a/en/api/@connectum/core/variables/TransportValidationMode.md +++ b/en/api/@connectum/core/variables/TransportValidationMode.md @@ -4,7 +4,7 @@ > `const` **TransportValidationMode**: `object` -Defined in: [packages/core/src/TransportValidation.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TransportValidation.ts#L37) +Defined in: [packages/core/src/TransportValidation.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TransportValidation.ts#L37) Validation severity. diff --git a/en/api/@connectum/core/variables/defaultPropagateHeaders.md b/en/api/@connectum/core/variables/defaultPropagateHeaders.md index c54078e5..b1066426 100644 --- a/en/api/@connectum/core/variables/defaultPropagateHeaders.md +++ b/en/api/@connectum/core/variables/defaultPropagateHeaders.md @@ -4,7 +4,7 @@ > `const` **defaultPropagateHeaders**: readonly `string`[] -Defined in: [packages/core/src/propagateHeaders.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/propagateHeaders.ts#L30) +Defined in: [packages/core/src/propagateHeaders.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/propagateHeaders.ts#L30) Recommended default allow-list: W3C trace-context headers only. diff --git a/en/api/@connectum/core/variables/tlsPath.md b/en/api/@connectum/core/variables/tlsPath.md index 5035471a..ad3bd4f5 100644 --- a/en/api/@connectum/core/variables/tlsPath.md +++ b/en/api/@connectum/core/variables/tlsPath.md @@ -4,6 +4,6 @@ > `const` **tlsPath**: `string` -Defined in: [packages/core/src/TLSConfig.ts:63](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/core/src/TLSConfig.ts#L63) +Defined in: [packages/core/src/TLSConfig.ts:63](https://github.com/Connectum-Framework/connectum/blob/main/packages/core/src/TLSConfig.ts#L63) Exported for backward compatibility diff --git a/en/api/@connectum/events-amqp/classes/AmqpAdapterError.md b/en/api/@connectum/events-amqp/classes/AmqpAdapterError.md index 0f421fbf..c2838bd6 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpAdapterError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpAdapterError.md @@ -2,7 +2,7 @@ # Class: AmqpAdapterError -Defined in: [packages/events-amqp/src/errors.ts:13](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L13) +Defined in: [packages/events-amqp/src/errors.ts:13](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L13) Base class for all AMQP adapter errors. @@ -25,7 +25,7 @@ Base class for all AMQP adapter errors. > **new AmqpAdapterError**(`message`, `options?`): `AmqpAdapterError` -Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L14) +Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L14) #### Parameters diff --git a/en/api/@connectum/events-amqp/classes/AmqpConnectionError.md b/en/api/@connectum/events-amqp/classes/AmqpConnectionError.md index e7bca804..5c1a9056 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpConnectionError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpConnectionError.md @@ -2,7 +2,7 @@ # Class: AmqpConnectionError -Defined in: [packages/events-amqp/src/errors.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L25) +Defined in: [packages/events-amqp/src/errors.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L25) Connection is absent, lost, or recovery is in progress / exhausted. Publishes during a disconnected window fail fast with this error; @@ -18,7 +18,7 @@ in-flight confirms are rejected with it on connection loss. > **new AmqpConnectionError**(`message`, `options?`): `AmqpConnectionError` -Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L14) +Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L14) #### Parameters diff --git a/en/api/@connectum/events-amqp/classes/AmqpPublishNackError.md b/en/api/@connectum/events-amqp/classes/AmqpPublishNackError.md index e58f45e3..b0012121 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpPublishNackError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpPublishNackError.md @@ -2,7 +2,7 @@ # Class: AmqpPublishNackError -Defined in: [packages/events-amqp/src/errors.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L41) +Defined in: [packages/events-amqp/src/errors.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L41) The broker negatively acknowledged (nacked) a published message. @@ -16,7 +16,7 @@ The broker negatively acknowledged (nacked) a published message. > **new AmqpPublishNackError**(`message`, `options?`): `AmqpPublishNackError` -Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L14) +Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L14) #### Parameters diff --git a/en/api/@connectum/events-amqp/classes/AmqpPublishTimeoutError.md b/en/api/@connectum/events-amqp/classes/AmqpPublishTimeoutError.md index 3641c1ba..450fd475 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpPublishTimeoutError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpPublishTimeoutError.md @@ -2,7 +2,7 @@ # Class: AmqpPublishTimeoutError -Defined in: [packages/events-amqp/src/errors.ts:48](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L48) +Defined in: [packages/events-amqp/src/errors.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L48) No broker outcome (ack/nack/return/connection loss) arrived within `publishTimeoutMs`. The message state is UNKNOWN — it may or may not @@ -18,7 +18,7 @@ have been routed; an at-least-once producer should republish. > **new AmqpPublishTimeoutError**(`message`, `options?`): `AmqpPublishTimeoutError` -Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L14) +Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L14) #### Parameters diff --git a/en/api/@connectum/events-amqp/classes/AmqpSerializationError.md b/en/api/@connectum/events-amqp/classes/AmqpSerializationError.md index dd251d27..afaa04fd 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpSerializationError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpSerializationError.md @@ -2,7 +2,7 @@ # Class: AmqpSerializationError -Defined in: [packages/events-amqp/src/errors.ts:58](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L58) +Defined in: [packages/events-amqp/src/errors.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L58) Payload encoding/decoding failed in a custom serialization hook. @@ -16,7 +16,7 @@ Payload encoding/decoding failed in a custom serialization hook. > **new AmqpSerializationError**(`message`, `options?`): `AmqpSerializationError` -Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L14) +Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L14) #### Parameters diff --git a/en/api/@connectum/events-amqp/classes/AmqpTopologyError.md b/en/api/@connectum/events-amqp/classes/AmqpTopologyError.md index f7078d89..76be3959 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpTopologyError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpTopologyError.md @@ -2,7 +2,7 @@ # Class: AmqpTopologyError -Defined in: [packages/events-amqp/src/errors.ts:55](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L55) +Defined in: [packages/events-amqp/src/errors.ts:55](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L55) Topology declaration or verification failed: missing exchange/queue in `check`/`skip` mode, or a conflicting redeclare (PRECONDITION_FAILED) in @@ -18,7 +18,7 @@ Topology declaration or verification failed: missing exchange/queue in > **new AmqpTopologyError**(`message`, `options?`): `AmqpTopologyError` -Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L14) +Defined in: [packages/events-amqp/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L14) #### Parameters diff --git a/en/api/@connectum/events-amqp/classes/AmqpUnroutableError.md b/en/api/@connectum/events-amqp/classes/AmqpUnroutableError.md index e4862521..b91b6149 100644 --- a/en/api/@connectum/events-amqp/classes/AmqpUnroutableError.md +++ b/en/api/@connectum/events-amqp/classes/AmqpUnroutableError.md @@ -2,7 +2,7 @@ # Class: AmqpUnroutableError -Defined in: [packages/events-amqp/src/errors.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L31) +Defined in: [packages/events-amqp/src/errors.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L31) The broker returned a `mandatory` message as unroutable (`basic.return`): no queue is bound for the routing key. @@ -17,7 +17,7 @@ The broker returned a `mandatory` message as unroutable > **new AmqpUnroutableError**(`message`, `routingKey`): `AmqpUnroutableError` -Defined in: [packages/events-amqp/src/errors.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L34) +Defined in: [packages/events-amqp/src/errors.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L34) #### Parameters @@ -79,7 +79,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `readonly` **routingKey**: `string` -Defined in: [packages/events-amqp/src/errors.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/errors.ts#L32) +Defined in: [packages/events-amqp/src/errors.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/errors.ts#L32) *** diff --git a/en/api/@connectum/events-amqp/functions/AmqpAdapter.md b/en/api/@connectum/events-amqp/functions/AmqpAdapter.md index c0ed4b47..774b88d0 100644 --- a/en/api/@connectum/events-amqp/functions/AmqpAdapter.md +++ b/en/api/@connectum/events-amqp/functions/AmqpAdapter.md @@ -4,7 +4,7 @@ > **AmqpAdapter**(`options`): `EventAdapter` -Defined in: [packages/events-amqp/src/AmqpAdapter.ts:152](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/AmqpAdapter.ts#L152) +Defined in: [packages/events-amqp/src/AmqpAdapter.ts:152](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/AmqpAdapter.ts#L152) Create an AMQP/RabbitMQ adapter for @connectum/events. diff --git a/en/api/@connectum/events-amqp/functions/toAmqpPattern.md b/en/api/@connectum/events-amqp/functions/toAmqpPattern.md index f99058f3..e51ffaff 100644 --- a/en/api/@connectum/events-amqp/functions/toAmqpPattern.md +++ b/en/api/@connectum/events-amqp/functions/toAmqpPattern.md @@ -4,7 +4,7 @@ > **toAmqpPattern**(`pattern`): `string` -Defined in: [packages/events-amqp/src/AmqpAdapter.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/AmqpAdapter.ts#L53) +Defined in: [packages/events-amqp/src/AmqpAdapter.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/AmqpAdapter.ts#L53) Convert an EventBus wildcard pattern to an AMQP routing key pattern. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md index 1a5bc76b..56a516fe 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpAdapterOptions -Defined in: [packages/events-amqp/src/types.ts:10](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L10) +Defined in: [packages/events-amqp/src/types.ts:10](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L10) Options for creating an AMQP/RabbitMQ adapter. @@ -12,7 +12,7 @@ Options for creating an AMQP/RabbitMQ adapter. > `readonly` `optional` **consumerOptions?**: [`AmqpConsumerOptions`](AmqpConsumerOptions.md) -Defined in: [packages/events-amqp/src/types.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L50) +Defined in: [packages/events-amqp/src/types.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L50) Consumer options. @@ -22,7 +22,7 @@ Consumer options. > `readonly` `optional` **exchange?**: `string` -Defined in: [packages/events-amqp/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L28) +Defined in: [packages/events-amqp/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L28) Exchange name for publishing and subscribing. @@ -38,7 +38,7 @@ Exchange name for publishing and subscribing. > `readonly` `optional` **exchangeOptions?**: [`AmqpExchangeOptions`](AmqpExchangeOptions.md) -Defined in: [packages/events-amqp/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L40) +Defined in: [packages/events-amqp/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L40) Exchange assertion options. @@ -48,7 +48,7 @@ Exchange assertion options. > `readonly` `optional` **exchangeType?**: `"headers"` \| `"topic"` \| `"direct"` \| `"fanout"` -Defined in: [packages/events-amqp/src/types.ts:35](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L35) +Defined in: [packages/events-amqp/src/types.ts:35](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L35) Exchange type. @@ -64,7 +64,7 @@ Exchange type. > `readonly` `optional` **lifecycle?**: [`AmqpLifecycleCallbacks`](AmqpLifecycleCallbacks.md) -Defined in: [packages/events-amqp/src/types.ts:117](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L117) +Defined in: [packages/events-amqp/src/types.ts:117](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L117) Connection lifecycle callbacks. Connection errors are surfaced here — not just logged. @@ -75,7 +75,7 @@ not just logged. > `readonly` `optional` **publisherOptions?**: [`AmqpPublisherOptions`](AmqpPublisherOptions.md) -Defined in: [packages/events-amqp/src/types.ts:55](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L55) +Defined in: [packages/events-amqp/src/types.ts:55](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L55) Publisher options. @@ -85,7 +85,7 @@ Publisher options. > `readonly` `optional` **publishTimeoutMs?**: `number` -Defined in: [packages/events-amqp/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L127) +Defined in: [packages/events-amqp/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L127) Per-publish broker-outcome deadline in milliseconds. A publish whose ack/nack/return/connection-loss outcome does not arrive in time @@ -104,7 +104,7 @@ at-least-once producer should republish). > `readonly` `optional` **queueOptions?**: [`AmqpQueueOptions`](AmqpQueueOptions.md) -Defined in: [packages/events-amqp/src/types.ts:45](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L45) +Defined in: [packages/events-amqp/src/types.ts:45](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L45) Default queue assertion options. @@ -114,7 +114,7 @@ Default queue assertion options. > `readonly` `optional` **queueOverrides?**: `Record`\<`string`, [`AmqpQueueOverride`](AmqpQueueOverride.md)\> -Defined in: [packages/events-amqp/src/types.ts:97](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L97) +Defined in: [packages/events-amqp/src/types.ts:97](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L97) Map a consumer group name to an externally-named queue. @@ -128,7 +128,7 @@ lets a subscription attach to a queue from an external contract > `readonly` `optional` **recovery?**: `boolean` \| [`AmqpRecoveryOptions`](AmqpRecoveryOptions.md) -Defined in: [packages/events-amqp/src/types.ts:111](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L111) +Defined in: [packages/events-amqp/src/types.ts:111](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L111) Automatic connection recovery (delegated to amqplib's opt-in recovery). Enabled by default; pass `false` to restore @@ -151,7 +151,7 @@ true (amqplib defaults: 100ms initial, ×2, 30s cap, jitter 0.2, infinite retrie > `readonly` `optional` **serialization?**: [`AmqpSerializationOptions`](AmqpSerializationOptions.md) -Defined in: [packages/events-amqp/src/types.ts:66](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L66) +Defined in: [packages/events-amqp/src/types.ts:66](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L66) Message serialization metadata and optional wire transcoding. @@ -167,7 +167,7 @@ adapter directly against an external AsyncAPI contract. > `readonly` `optional` **socketOptions?**: `Record`\<`string`, `unknown`\> -Defined in: [packages/events-amqp/src/types.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L21) +Defined in: [packages/events-amqp/src/types.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L21) Socket options passed to `amqplib.connect()`. @@ -177,7 +177,7 @@ Socket options passed to `amqplib.connect()`. > `readonly` `optional` **topology?**: [`AmqpTopology`](AmqpTopology.md) -Defined in: [packages/events-amqp/src/types.ts:74](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L74) +Defined in: [packages/events-amqp/src/types.ts:74](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L74) Explicit topology to declare on connect (and re-declare after recovery): exchanges, queues with arbitrary external names and raw @@ -190,7 +190,7 @@ exchange-to-exchange. > `readonly` `optional` **topologyMode?**: [`AmqpTopologyMode`](../type-aliases/AmqpTopologyMode.md) -Defined in: [packages/events-amqp/src/types.ts:88](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L88) +Defined in: [packages/events-amqp/src/types.ts:88](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L88) How topology is established: - `"assert"` (default) — declare idempotently (assertExchange/assertQueue/bind); @@ -213,7 +213,7 @@ How topology is established: > `readonly` **url**: `string` -Defined in: [packages/events-amqp/src/types.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L16) +Defined in: [packages/events-amqp/src/types.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L16) AMQP connection URL. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md index 38324baf..8b5b8317 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md @@ -2,7 +2,7 @@ # Interface: AmqpBindingDeclaration -Defined in: [packages/events-amqp/src/types.ts:187](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L187) +Defined in: [packages/events-amqp/src/types.ts:187](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L187) ## Properties @@ -10,7 +10,7 @@ Defined in: [packages/events-amqp/src/types.ts:187](https://github.com/Connectum > `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\> -Defined in: [packages/events-amqp/src/types.ts:195](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L195) +Defined in: [packages/events-amqp/src/types.ts:195](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L195) *** @@ -18,7 +18,7 @@ Defined in: [packages/events-amqp/src/types.ts:195](https://github.com/Connectum > `readonly` `optional` **exchange?**: `string` -Defined in: [packages/events-amqp/src/types.ts:191](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L191) +Defined in: [packages/events-amqp/src/types.ts:191](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L191) Destination exchange name (exchange-to-exchange binding). @@ -28,7 +28,7 @@ Destination exchange name (exchange-to-exchange binding). > `readonly` `optional` **queue?**: `string` -Defined in: [packages/events-amqp/src/types.ts:189](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L189) +Defined in: [packages/events-amqp/src/types.ts:189](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L189) Destination queue name (queue binding) — mutually exclusive with `exchange`. @@ -38,7 +38,7 @@ Destination queue name (queue binding) — mutually exclusive with `exchange`. > `readonly` **routingKey**: `string` -Defined in: [packages/events-amqp/src/types.ts:194](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L194) +Defined in: [packages/events-amqp/src/types.ts:194](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L194) *** @@ -46,6 +46,6 @@ Defined in: [packages/events-amqp/src/types.ts:194](https://github.com/Connectum > `readonly` **source**: `string` -Defined in: [packages/events-amqp/src/types.ts:193](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L193) +Defined in: [packages/events-amqp/src/types.ts:193](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L193) Source exchange. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md index be0a4e2d..2cc843ac 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpConsumerOptions -Defined in: [packages/events-amqp/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L284) +Defined in: [packages/events-amqp/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L284) Consumer options. @@ -12,7 +12,7 @@ Consumer options. > `readonly` `optional` **exclusive?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L298) +Defined in: [packages/events-amqp/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L298) Whether the consumer is exclusive to this connection. @@ -28,7 +28,7 @@ false > `readonly` `optional` **prefetch?**: `number` -Defined in: [packages/events-amqp/src/types.ts:291](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L291) +Defined in: [packages/events-amqp/src/types.ts:291](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L291) Prefetch count (QoS) — how many unacknowledged messages a consumer can have at a time. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md index 5ba3bb37..f5ad4cf8 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md @@ -2,7 +2,7 @@ # Interface: AmqpExchangeDeclaration -Defined in: [packages/events-amqp/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L169) +Defined in: [packages/events-amqp/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L169) ## Properties @@ -10,7 +10,7 @@ Defined in: [packages/events-amqp/src/types.ts:169](https://github.com/Connectum > `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\> -Defined in: [packages/events-amqp/src/types.ts:175](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L175) +Defined in: [packages/events-amqp/src/types.ts:175](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L175) Raw AMQP arguments passthrough. @@ -20,7 +20,7 @@ Raw AMQP arguments passthrough. > `readonly` `optional` **autoDelete?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:173](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L173) +Defined in: [packages/events-amqp/src/types.ts:173](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L173) *** @@ -28,7 +28,7 @@ Defined in: [packages/events-amqp/src/types.ts:173](https://github.com/Connectum > `readonly` `optional` **durable?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:172](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L172) +Defined in: [packages/events-amqp/src/types.ts:172](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L172) *** @@ -36,7 +36,7 @@ Defined in: [packages/events-amqp/src/types.ts:172](https://github.com/Connectum > `readonly` **name**: `string` -Defined in: [packages/events-amqp/src/types.ts:170](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L170) +Defined in: [packages/events-amqp/src/types.ts:170](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L170) *** @@ -44,4 +44,4 @@ Defined in: [packages/events-amqp/src/types.ts:170](https://github.com/Connectum > `readonly` **type**: `"headers"` \| `"topic"` \| `"direct"` \| `"fanout"` -Defined in: [packages/events-amqp/src/types.ts:171](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L171) +Defined in: [packages/events-amqp/src/types.ts:171](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L171) diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md index 4ecf34ec..ec8043d7 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpExchangeOptions -Defined in: [packages/events-amqp/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L233) +Defined in: [packages/events-amqp/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L233) Exchange assertion options. @@ -12,7 +12,7 @@ Exchange assertion options. > `readonly` `optional` **autoDelete?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:246](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L246) +Defined in: [packages/events-amqp/src/types.ts:246](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L246) Whether the exchange is deleted when the last queue unbinds. @@ -28,7 +28,7 @@ false > `readonly` `optional` **durable?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:239](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L239) +Defined in: [packages/events-amqp/src/types.ts:239](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L239) Whether the exchange should survive broker restarts. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md index 72d0313c..1aa82d93 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md @@ -2,7 +2,7 @@ # Interface: AmqpLifecycleCallbacks -Defined in: [packages/events-amqp/src/types.ts:223](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L223) +Defined in: [packages/events-amqp/src/types.ts:223](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L223) Connection lifecycle callbacks. @@ -12,7 +12,7 @@ Connection lifecycle callbacks. > `readonly` `optional` **onConnected?**: () => `void` -Defined in: [packages/events-amqp/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L224) +Defined in: [packages/events-amqp/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L224) #### Returns @@ -24,7 +24,7 @@ Defined in: [packages/events-amqp/src/types.ts:224](https://github.com/Connectum > `readonly` `optional` **onDisconnected?**: (`cause`) => `void` -Defined in: [packages/events-amqp/src/types.ts:225](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L225) +Defined in: [packages/events-amqp/src/types.ts:225](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L225) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/events-amqp/src/types.ts:225](https://github.com/Connectum > `readonly` `optional` **onReconnectFailed?**: (`cause`) => `void` -Defined in: [packages/events-amqp/src/types.ts:227](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L227) +Defined in: [packages/events-amqp/src/types.ts:227](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L227) #### Parameters @@ -60,7 +60,7 @@ Defined in: [packages/events-amqp/src/types.ts:227](https://github.com/Connectum > `readonly` `optional` **onReconnecting?**: (`info`) => `void` -Defined in: [packages/events-amqp/src/types.ts:226](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L226) +Defined in: [packages/events-amqp/src/types.ts:226](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L226) #### Parameters diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md index 111c1b7e..d31ed849 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpPublisherOptions -Defined in: [packages/events-amqp/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L304) +Defined in: [packages/events-amqp/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L304) Publisher options. @@ -12,7 +12,7 @@ Publisher options. > `readonly` `optional` **correlationHeader?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:333](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L333) +Defined in: [packages/events-amqp/src/types.ts:333](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L333) How `basic.return` frames are correlated to publishes when `mandatory: true`. The return frame carries no deliveryTag, so: @@ -36,7 +36,7 @@ true > `readonly` `optional` **mandatory?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:318](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L318) +Defined in: [packages/events-amqp/src/types.ts:318](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L318) Whether the message should be returned if it cannot be routed. Unroutable messages reject the publish with `AmqpUnroutableError`. @@ -53,7 +53,7 @@ false > `readonly` `optional` **persistent?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:310](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L310) +Defined in: [packages/events-amqp/src/types.ts:310](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L310) Whether messages should be persisted to disk (deliveryMode=2). diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md index 67bec792..1384d9a6 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md @@ -2,7 +2,7 @@ # Interface: AmqpQueueDeclaration -Defined in: [packages/events-amqp/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L178) +Defined in: [packages/events-amqp/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L178) ## Properties @@ -10,7 +10,7 @@ Defined in: [packages/events-amqp/src/types.ts:178](https://github.com/Connectum > `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\> -Defined in: [packages/events-amqp/src/types.ts:184](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L184) +Defined in: [packages/events-amqp/src/types.ts:184](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L184) Raw AMQP arguments passthrough (e.g. x-dead-letter-exchange). @@ -20,7 +20,7 @@ Raw AMQP arguments passthrough (e.g. x-dead-letter-exchange). > `readonly` `optional` **autoDelete?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:181](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L181) +Defined in: [packages/events-amqp/src/types.ts:181](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L181) *** @@ -28,7 +28,7 @@ Defined in: [packages/events-amqp/src/types.ts:181](https://github.com/Connectum > `readonly` `optional` **durable?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L180) +Defined in: [packages/events-amqp/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L180) *** @@ -36,7 +36,7 @@ Defined in: [packages/events-amqp/src/types.ts:180](https://github.com/Connectum > `readonly` `optional` **exclusive?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:182](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L182) +Defined in: [packages/events-amqp/src/types.ts:182](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L182) *** @@ -44,4 +44,4 @@ Defined in: [packages/events-amqp/src/types.ts:182](https://github.com/Connectum > `readonly` **name**: `string` -Defined in: [packages/events-amqp/src/types.ts:179](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L179) +Defined in: [packages/events-amqp/src/types.ts:179](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L179) diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md index 20ac4446..ee3e175e 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpQueueOptions -Defined in: [packages/events-amqp/src/types.ts:252](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L252) +Defined in: [packages/events-amqp/src/types.ts:252](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L252) Queue assertion options. @@ -12,7 +12,7 @@ Queue assertion options. > `readonly` `optional` **deadLetterExchange?**: `string` -Defined in: [packages/events-amqp/src/types.ts:273](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L273) +Defined in: [packages/events-amqp/src/types.ts:273](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L273) Dead letter exchange name for rejected messages. @@ -22,7 +22,7 @@ Dead letter exchange name for rejected messages. > `readonly` `optional` **deadLetterRoutingKey?**: `string` -Defined in: [packages/events-amqp/src/types.ts:278](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L278) +Defined in: [packages/events-amqp/src/types.ts:278](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L278) Dead letter routing key for rejected messages. @@ -32,7 +32,7 @@ Dead letter routing key for rejected messages. > `readonly` `optional` **durable?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:258](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L258) +Defined in: [packages/events-amqp/src/types.ts:258](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L258) Whether the queue should survive broker restarts. @@ -48,7 +48,7 @@ true > `readonly` `optional` **maxLength?**: `number` -Defined in: [packages/events-amqp/src/types.ts:268](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L268) +Defined in: [packages/events-amqp/src/types.ts:268](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L268) Maximum number of messages in the queue. @@ -58,6 +58,6 @@ Maximum number of messages in the queue. > `readonly` `optional` **messageTtl?**: `number` -Defined in: [packages/events-amqp/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L263) +Defined in: [packages/events-amqp/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L263) Per-message TTL in milliseconds. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOverride.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOverride.md index 54734b5c..0a283dff 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOverride.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOverride.md @@ -2,7 +2,7 @@ # Interface: AmqpQueueOverride -Defined in: [packages/events-amqp/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L199) +Defined in: [packages/events-amqp/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L199) External queue override for a consumer group. @@ -12,7 +12,7 @@ External queue override for a consumer group. > `readonly` `optional` **arguments?**: `Record`\<`string`, `unknown`\> -Defined in: [packages/events-amqp/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L203) +Defined in: [packages/events-amqp/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L203) Raw AMQP arguments used when asserting the queue (assert mode only). @@ -22,7 +22,7 @@ Raw AMQP arguments used when asserting the queue (assert mode only). > `readonly` `optional` **durable?**: `boolean` -Defined in: [packages/events-amqp/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L205) +Defined in: [packages/events-amqp/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L205) #### Default @@ -36,6 +36,6 @@ true > `readonly` **queue**: `string` -Defined in: [packages/events-amqp/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L201) +Defined in: [packages/events-amqp/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L201) Externally-defined queue name to consume from. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpRecoveryOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpRecoveryOptions.md index a17cdb83..110653a5 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpRecoveryOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpRecoveryOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpRecoveryOptions -Defined in: [packages/events-amqp/src/types.ts:209](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L209) +Defined in: [packages/events-amqp/src/types.ts:209](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L209) Recovery knobs (passed through to amqplib's opt-in recovery). @@ -12,7 +12,7 @@ Recovery knobs (passed through to amqplib's opt-in recovery). > `readonly` `optional` **factor?**: `number` -Defined in: [packages/events-amqp/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L215) +Defined in: [packages/events-amqp/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L215) #### Default @@ -26,7 +26,7 @@ Defined in: [packages/events-amqp/src/types.ts:215](https://github.com/Connectum > `readonly` `optional` **initialDelay?**: `number` -Defined in: [packages/events-amqp/src/types.ts:211](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L211) +Defined in: [packages/events-amqp/src/types.ts:211](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L211) #### Default @@ -40,7 +40,7 @@ Defined in: [packages/events-amqp/src/types.ts:211](https://github.com/Connectum > `readonly` `optional` **jitter?**: `number` -Defined in: [packages/events-amqp/src/types.ts:217](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L217) +Defined in: [packages/events-amqp/src/types.ts:217](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L217) 0..1 @@ -56,7 +56,7 @@ Defined in: [packages/events-amqp/src/types.ts:217](https://github.com/Connectum > `readonly` `optional` **maxDelay?**: `number` -Defined in: [packages/events-amqp/src/types.ts:213](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L213) +Defined in: [packages/events-amqp/src/types.ts:213](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L213) #### Default @@ -70,7 +70,7 @@ Defined in: [packages/events-amqp/src/types.ts:213](https://github.com/Connectum > `readonly` `optional` **maxRetries?**: `number` -Defined in: [packages/events-amqp/src/types.ts:219](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L219) +Defined in: [packages/events-amqp/src/types.ts:219](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L219) #### Default diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpSerializationOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpSerializationOptions.md index 8c792b19..ec04a3b0 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpSerializationOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpSerializationOptions.md @@ -2,7 +2,7 @@ # Interface: AmqpSerializationOptions -Defined in: [packages/events-amqp/src/types.ts:140](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L140) +Defined in: [packages/events-amqp/src/types.ts:140](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L140) Serialization metadata and optional wire transcoding. @@ -12,7 +12,7 @@ Serialization metadata and optional wire transcoding. > `readonly` `optional` **contentType?**: `string` -Defined in: [packages/events-amqp/src/types.ts:146](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L146) +Defined in: [packages/events-amqp/src/types.ts:146](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L146) AMQP `contentType` message property. @@ -28,7 +28,7 @@ AMQP `contentType` message property. > `readonly` `optional` **decode?**: (`content`) => `Uint8Array` -Defined in: [packages/events-amqp/src/types.ts:159](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L159) +Defined in: [packages/events-amqp/src/types.ts:159](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L159) Transform the incoming wire body before it reaches the event handler. Failures nack the message (requeue per consumer policy). @@ -49,7 +49,7 @@ Failures nack the message (requeue per consumer policy). > `readonly` `optional` **encode?**: (`payload`) => `Uint8Array` -Defined in: [packages/events-amqp/src/types.ts:153](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L153) +Defined in: [packages/events-amqp/src/types.ts:153](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L153) Transform the outgoing wire body. Receives the payload bytes the EventBus (or the application) produced. Failures reject the publish diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpTopology.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpTopology.md index 5c7a3767..03952af0 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpTopology.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpTopology.md @@ -2,7 +2,7 @@ # Interface: AmqpTopology -Defined in: [packages/events-amqp/src/types.ts:163](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L163) +Defined in: [packages/events-amqp/src/types.ts:163](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L163) Declarative topology. @@ -12,7 +12,7 @@ Declarative topology. > `readonly` `optional` **bindings?**: readonly [`AmqpBindingDeclaration`](AmqpBindingDeclaration.md)[] -Defined in: [packages/events-amqp/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L166) +Defined in: [packages/events-amqp/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L166) *** @@ -20,7 +20,7 @@ Defined in: [packages/events-amqp/src/types.ts:166](https://github.com/Connectum > `readonly` `optional` **exchanges?**: readonly [`AmqpExchangeDeclaration`](AmqpExchangeDeclaration.md)[] -Defined in: [packages/events-amqp/src/types.ts:164](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L164) +Defined in: [packages/events-amqp/src/types.ts:164](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L164) *** @@ -28,4 +28,4 @@ Defined in: [packages/events-amqp/src/types.ts:164](https://github.com/Connectum > `readonly` `optional` **queues?**: readonly [`AmqpQueueDeclaration`](AmqpQueueDeclaration.md)[] -Defined in: [packages/events-amqp/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L165) +Defined in: [packages/events-amqp/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L165) diff --git a/en/api/@connectum/events-amqp/types/type-aliases/AmqpTopologyMode.md b/en/api/@connectum/events-amqp/types/type-aliases/AmqpTopologyMode.md index 5bf55403..a514153e 100644 --- a/en/api/@connectum/events-amqp/types/type-aliases/AmqpTopologyMode.md +++ b/en/api/@connectum/events-amqp/types/type-aliases/AmqpTopologyMode.md @@ -4,6 +4,6 @@ > **AmqpTopologyMode** = *typeof* [`AmqpTopologyMode`](../variables/AmqpTopologyMode.md)\[keyof *typeof* [`AmqpTopologyMode`](../variables/AmqpTopologyMode.md)\] -Defined in: [packages/events-amqp/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L131) +Defined in: [packages/events-amqp/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L131) Topology establishment mode. diff --git a/en/api/@connectum/events-amqp/types/variables/AmqpTopologyMode.md b/en/api/@connectum/events-amqp/types/variables/AmqpTopologyMode.md index 3fa6744b..15744862 100644 --- a/en/api/@connectum/events-amqp/types/variables/AmqpTopologyMode.md +++ b/en/api/@connectum/events-amqp/types/variables/AmqpTopologyMode.md @@ -4,7 +4,7 @@ > `const` **AmqpTopologyMode**: `object` -Defined in: [packages/events-amqp/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-amqp/src/types.ts#L131) +Defined in: [packages/events-amqp/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L131) Topology establishment mode. diff --git a/en/api/@connectum/events-kafka/functions/KafkaAdapter.md b/en/api/@connectum/events-kafka/functions/KafkaAdapter.md index fa9c2315..f2bf5a41 100644 --- a/en/api/@connectum/events-kafka/functions/KafkaAdapter.md +++ b/en/api/@connectum/events-kafka/functions/KafkaAdapter.md @@ -4,7 +4,7 @@ > **KafkaAdapter**(`options`): `EventAdapter` -Defined in: [KafkaAdapter.ts:122](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/KafkaAdapter.ts#L122) +Defined in: [KafkaAdapter.ts:122](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/KafkaAdapter.ts#L122) Create a Kafka/Redpanda adapter for @connectum/events. diff --git a/en/api/@connectum/events-kafka/types/interfaces/KafkaAdapterOptions.md b/en/api/@connectum/events-kafka/types/interfaces/KafkaAdapterOptions.md index b1af3be0..a10b8f68 100644 --- a/en/api/@connectum/events-kafka/types/interfaces/KafkaAdapterOptions.md +++ b/en/api/@connectum/events-kafka/types/interfaces/KafkaAdapterOptions.md @@ -2,7 +2,7 @@ # Interface: KafkaAdapterOptions -Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/types.ts#L12) Options for creating a KafkaAdapter instance. @@ -12,7 +12,7 @@ Options for creating a KafkaAdapter instance. > `readonly` **brokers**: `string`[] -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/types.ts#L14) Kafka broker addresses (e.g., ["localhost:9092"]) @@ -22,7 +22,7 @@ Kafka broker addresses (e.g., ["localhost:9092"]) > `readonly` `optional` **clientId?**: `string` -Defined in: [types.ts:17](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/types.ts#L17) +Defined in: [types.ts:17](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/types.ts#L17) Client ID for this producer/consumer (default: "connectum") @@ -32,7 +32,7 @@ Client ID for this producer/consumer (default: "connectum") > `readonly` `optional` **consumerOptions?**: `object` -Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/types.ts#L32) Consumer-specific options @@ -60,7 +60,7 @@ Session timeout in milliseconds (default: 30000) > `readonly` `optional` **kafkaConfig?**: `Omit`\<`Partial`\<`KafkaConfig`\>, `"brokers"` \| `"clientId"`\> -Defined in: [types.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/types.ts#L23) +Defined in: [types.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/types.ts#L23) Additional KafkaJS configuration overrides. Merged with brokers and clientId. @@ -71,7 +71,7 @@ Merged with brokers and clientId. > `readonly` `optional` **producerOptions?**: `object` -Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-kafka/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-kafka/src/types.ts#L26) Producer-specific options diff --git a/en/api/@connectum/events-nats/functions/NatsAdapter.md b/en/api/@connectum/events-nats/functions/NatsAdapter.md index 8aece187..6afcfcb5 100644 --- a/en/api/@connectum/events-nats/functions/NatsAdapter.md +++ b/en/api/@connectum/events-nats/functions/NatsAdapter.md @@ -4,7 +4,7 @@ > **NatsAdapter**(`options`): `EventAdapter` -Defined in: [NatsAdapter.ts:83](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/NatsAdapter.ts#L83) +Defined in: [NatsAdapter.ts:83](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/NatsAdapter.ts#L83) Create a NATS JetStream adapter. diff --git a/en/api/@connectum/events-nats/types/interfaces/NatsAdapterOptions.md b/en/api/@connectum/events-nats/types/interfaces/NatsAdapterOptions.md index fbef16a7..742064f7 100644 --- a/en/api/@connectum/events-nats/types/interfaces/NatsAdapterOptions.md +++ b/en/api/@connectum/events-nats/types/interfaces/NatsAdapterOptions.md @@ -2,7 +2,7 @@ # Interface: NatsAdapterOptions -Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L12) Options for creating a NATS JetStream adapter. @@ -12,7 +12,7 @@ Options for creating a NATS JetStream adapter. > `readonly` `optional` **connectionOptions?**: `Partial`\<`NodeConnectionOptions`\> -Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L32) NATS connection options (escape hatch for advanced config). @@ -25,7 +25,7 @@ top-level `servers` option. > `readonly` `optional` **consumerOptions?**: [`NatsConsumerOptions`](NatsConsumerOptions.md) -Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L35) +Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L35) JetStream consumer tuning options. @@ -35,7 +35,7 @@ JetStream consumer tuning options. > `readonly` **servers**: `string` \| `string`[] -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L14) NATS server URL(s). Accepts a single string or an array. @@ -45,7 +45,7 @@ NATS server URL(s). Accepts a single string or an array. > `readonly` `optional` **stream?**: `string` -Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L24) +Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L24) JetStream stream name. diff --git a/en/api/@connectum/events-nats/types/interfaces/NatsConsumerOptions.md b/en/api/@connectum/events-nats/types/interfaces/NatsConsumerOptions.md index ad78a376..9266c76c 100644 --- a/en/api/@connectum/events-nats/types/interfaces/NatsConsumerOptions.md +++ b/en/api/@connectum/events-nats/types/interfaces/NatsConsumerOptions.md @@ -2,7 +2,7 @@ # Interface: NatsConsumerOptions -Defined in: [types.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L41) +Defined in: [types.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L41) Options for JetStream consumer behaviour. @@ -12,7 +12,7 @@ Options for JetStream consumer behaviour. > `readonly` `optional` **ackWait?**: `number` -Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L58) Ack wait timeout in milliseconds. After this period an unacknowledged message is redelivered. @@ -29,7 +29,7 @@ After this period an unacknowledged message is redelivered. > `readonly` `optional` **deliverPolicy?**: `"new"` \| `"all"` \| `"last"` -Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L50) Deliver policy for new consumers. - `"new"` — only messages published after consumer creation @@ -48,7 +48,7 @@ Deliver policy for new consumers. > `readonly` `optional` **maxDeliver?**: `number` -Defined in: [types.ts:66](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-nats/src/types.ts#L66) +Defined in: [types.ts:66](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-nats/src/types.ts#L66) Maximum number of delivery attempts before the message is discarded by the server. diff --git a/en/api/@connectum/events-redis/functions/RedisAdapter.md b/en/api/@connectum/events-redis/functions/RedisAdapter.md index d7b27c24..39824da4 100644 --- a/en/api/@connectum/events-redis/functions/RedisAdapter.md +++ b/en/api/@connectum/events-redis/functions/RedisAdapter.md @@ -4,7 +4,7 @@ > **RedisAdapter**(`options?`): `EventAdapter` -Defined in: [RedisAdapter.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/RedisAdapter.ts#L68) +Defined in: [RedisAdapter.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/RedisAdapter.ts#L68) Create a Redis Streams adapter for the Connectum event bus. diff --git a/en/api/@connectum/events-redis/types/interfaces/RedisAdapterOptions.md b/en/api/@connectum/events-redis/types/interfaces/RedisAdapterOptions.md index 8f6cc089..2730ed7b 100644 --- a/en/api/@connectum/events-redis/types/interfaces/RedisAdapterOptions.md +++ b/en/api/@connectum/events-redis/types/interfaces/RedisAdapterOptions.md @@ -2,7 +2,7 @@ # Interface: RedisAdapterOptions -Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L12) Options for creating a Redis Streams adapter. @@ -12,7 +12,7 @@ Options for creating a Redis Streams adapter. > `readonly` `optional` **brokerOptions?**: [`RedisBrokerOptions`](RedisBrokerOptions.md) -Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L32) Broker-specific tuning for Redis Streams consumption. @@ -22,7 +22,7 @@ Broker-specific tuning for Redis Streams consumption. > `readonly` `optional` **redisOptions?**: `RedisOptions` -Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L27) Redis connection options (alternative to `url`). @@ -35,7 +35,7 @@ When `url` is also set, these options are merged as the second argument. > `readonly` `optional` **url?**: `string` -Defined in: [types.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L19) +Defined in: [types.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L19) Redis connection URL (e.g., "redis://localhost:6379"). diff --git a/en/api/@connectum/events-redis/types/interfaces/RedisBrokerOptions.md b/en/api/@connectum/events-redis/types/interfaces/RedisBrokerOptions.md index 41571baf..4968df83 100644 --- a/en/api/@connectum/events-redis/types/interfaces/RedisBrokerOptions.md +++ b/en/api/@connectum/events-redis/types/interfaces/RedisBrokerOptions.md @@ -2,7 +2,7 @@ # Interface: RedisBrokerOptions -Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L38) Redis Streams broker tuning options. @@ -12,7 +12,7 @@ Redis Streams broker tuning options. > `readonly` `optional` **blockMs?**: `number` -Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L56) Block timeout in milliseconds for XREADGROUP. @@ -31,7 +31,7 @@ before retrying the loop. > `readonly` `optional` **count?**: `number` -Defined in: [types.ts:63](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L63) +Defined in: [types.ts:63](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L63) Number of messages to read per XREADGROUP call. @@ -47,7 +47,7 @@ Number of messages to read per XREADGROUP call. > `readonly` `optional` **maxLen?**: `number` -Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events-redis/src/types.ts#L46) +Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-redis/src/types.ts#L46) Maximum stream length (MAXLEN approximate for XADD). diff --git a/en/api/@connectum/events/classes/EventRouterImpl.md b/en/api/@connectum/events/classes/EventRouterImpl.md index ac20fc14..5b8638d9 100644 --- a/en/api/@connectum/events/classes/EventRouterImpl.md +++ b/en/api/@connectum/events/classes/EventRouterImpl.md @@ -2,7 +2,7 @@ # Class: EventRouterImpl -Defined in: [packages/events/src/EventRouter.ts:17](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventRouter.ts#L17) +Defined in: [packages/events/src/EventRouter.ts:17](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventRouter.ts#L17) EventRouter implementation that collects route entries. @@ -26,7 +26,7 @@ EventRouter implementation that collects route entries. > `readonly` **entries**: [`EventRouteEntry`](../types/interfaces/EventRouteEntry.md)[] = `[]` -Defined in: [packages/events/src/EventRouter.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventRouter.ts#L18) +Defined in: [packages/events/src/EventRouter.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventRouter.ts#L18) *** @@ -34,7 +34,7 @@ Defined in: [packages/events/src/EventRouter.ts:18](https://github.com/Connectum > `readonly` **serviceNames**: `string`[] = `[]` -Defined in: [packages/events/src/EventRouter.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventRouter.ts#L19) +Defined in: [packages/events/src/EventRouter.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventRouter.ts#L19) ## Methods @@ -42,7 +42,7 @@ Defined in: [packages/events/src/EventRouter.ts:19](https://github.com/Connectum > **service**\<`S`\>(`serviceDesc`, `handlers`): `void` -Defined in: [packages/events/src/EventRouter.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventRouter.ts#L21) +Defined in: [packages/events/src/EventRouter.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventRouter.ts#L21) Register event handlers for a service diff --git a/en/api/@connectum/events/classes/NonRetryableError.md b/en/api/@connectum/events/classes/NonRetryableError.md index 76e13eaf..e8d0738e 100644 --- a/en/api/@connectum/events/classes/NonRetryableError.md +++ b/en/api/@connectum/events/classes/NonRetryableError.md @@ -2,7 +2,7 @@ # Class: NonRetryableError -Defined in: [packages/events/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L27) +Defined in: [packages/events/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L27) Error that should never be retried. @@ -26,7 +26,7 @@ throw new NonRetryableError("Invalid payload", { cause: validationError }); > **new NonRetryableError**(`message`, `options?`): `NonRetryableError` -Defined in: [packages/events/src/errors.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L30) +Defined in: [packages/events/src/errors.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L30) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/events/src/errors.ts:30](https://github.com/Connectum-Fram > `readonly` **\[NON\_RETRYABLE\]**: `true` = `true` -Defined in: [packages/events/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L28) +Defined in: [packages/events/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L28) *** @@ -224,7 +224,7 @@ Indicates whether the argument provided is a built-in Error instance or not. > `static` **isNonRetryable**(`error`): `error is { [NON_RETRYABLE]: true }` -Defined in: [packages/events/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L39) +Defined in: [packages/events/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L39) Check if an error is branded as non-retryable. Works across realms (Symbol.for is global). diff --git a/en/api/@connectum/events/classes/RetryableError.md b/en/api/@connectum/events/classes/RetryableError.md index fd7ee0ee..6b29af08 100644 --- a/en/api/@connectum/events/classes/RetryableError.md +++ b/en/api/@connectum/events/classes/RetryableError.md @@ -2,7 +2,7 @@ # Class: RetryableError -Defined in: [packages/events/src/errors.ts:56](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L56) +Defined in: [packages/events/src/errors.ts:56](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L56) Error that should always be retried. @@ -26,7 +26,7 @@ throw new RetryableError("Temporary DB connection lost", { cause: dbError }); > **new RetryableError**(`message`, `options?`): `RetryableError` -Defined in: [packages/events/src/errors.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L59) +Defined in: [packages/events/src/errors.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L59) #### Parameters @@ -52,7 +52,7 @@ Defined in: [packages/events/src/errors.ts:59](https://github.com/Connectum-Fram > `readonly` **\[RETRYABLE\]**: `true` = `true` -Defined in: [packages/events/src/errors.ts:57](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L57) +Defined in: [packages/events/src/errors.ts:57](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L57) *** @@ -224,7 +224,7 @@ Indicates whether the argument provided is a built-in Error instance or not. > `static` **isRetryable**(`error`): `error is { [RETRYABLE]: true }` -Defined in: [packages/events/src/errors.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/errors.ts#L68) +Defined in: [packages/events/src/errors.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/errors.ts#L68) Check if an error is branded as retryable. Works across realms (Symbol.for is global). diff --git a/en/api/@connectum/events/functions/MemoryAdapter.md b/en/api/@connectum/events/functions/MemoryAdapter.md index 5c55404c..d7b06c85 100644 --- a/en/api/@connectum/events/functions/MemoryAdapter.md +++ b/en/api/@connectum/events/functions/MemoryAdapter.md @@ -4,7 +4,7 @@ > **MemoryAdapter**(): [`EventAdapter`](../types/interfaces/EventAdapter.md) -Defined in: [packages/events/src/MemoryAdapter.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/MemoryAdapter.ts#L23) +Defined in: [packages/events/src/MemoryAdapter.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/MemoryAdapter.ts#L23) Create an in-memory adapter for testing event flows without an external message broker. diff --git a/en/api/@connectum/events/functions/composeMiddleware.md b/en/api/@connectum/events/functions/composeMiddleware.md index c31ae262..59f614ae 100644 --- a/en/api/@connectum/events/functions/composeMiddleware.md +++ b/en/api/@connectum/events/functions/composeMiddleware.md @@ -4,7 +4,7 @@ > **composeMiddleware**(`middlewares`, `handler`): (`event`, `ctx`) => `Promise`\<`void`\> -Defined in: [packages/events/src/middleware.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/middleware.ts#L24) +Defined in: [packages/events/src/middleware.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/middleware.ts#L24) Compose an array of middleware into a single handler. diff --git a/en/api/@connectum/events/functions/createBroadcastSubscribers.md b/en/api/@connectum/events/functions/createBroadcastSubscribers.md new file mode 100644 index 00000000..35d64130 --- /dev/null +++ b/en/api/@connectum/events/functions/createBroadcastSubscribers.md @@ -0,0 +1,40 @@ +[Connectum API Reference](../../../index.md) / [@connectum/events](../index.md) / createBroadcastSubscribers + +# Function: createBroadcastSubscribers() + +> **createBroadcastSubscribers**(`options`): [`EventBus`](../types/interfaces/EventBus.md) & `EventBusLike`[] + +Defined in: [packages/events/src/broadcast.ts:74](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L74) + +Build one `EventBus` per reactor (each with its own consumer group) so a +single published event fans out to ALL reactors independently. + +The returned buses are NOT started — start them yourself (e.g. +`await Promise.all(buses.map((b) => b.start()))`) and stop them on shutdown. + +Throws if two reactors share a consumer group (that would load-balance / steal +instead of fanning out). + +## Parameters + +### options + +[`BroadcastSubscribersOptions`](../interfaces/BroadcastSubscribersOptions.md) + +## Returns + +[`EventBus`](../types/interfaces/EventBus.md) & `EventBusLike`[] + +## Example + +```typescript +const buses = createBroadcastSubscribers({ + adapter: () => new NatsAdapter({ servers, stream: 'orders' }), + reactors: [ + { group: 'pricing', routes: [pricingRoutes] }, + { group: 'audit', routes: [auditRoutes] }, + { group: 'notify', routes: [notifyRoutes] }, + ], +}); +await Promise.all(buses.map((bus) => bus.start())); +``` diff --git a/en/api/@connectum/events/functions/createEventBus.md b/en/api/@connectum/events/functions/createEventBus.md index 1fc40d36..d692f5a1 100644 --- a/en/api/@connectum/events/functions/createEventBus.md +++ b/en/api/@connectum/events/functions/createEventBus.md @@ -4,7 +4,7 @@ > **createEventBus**(`options`): [`EventBus`](../types/interfaces/EventBus.md) & `EventBusLike` -Defined in: [packages/events/src/EventBus.ts:71](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventBus.ts#L71) +Defined in: [packages/events/src/EventBus.ts:72](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventBus.ts#L72) Create an EventBus instance. diff --git a/en/api/@connectum/events/functions/createEventContext.md b/en/api/@connectum/events/functions/createEventContext.md index 7a034857..ccaed0e8 100644 --- a/en/api/@connectum/events/functions/createEventContext.md +++ b/en/api/@connectum/events/functions/createEventContext.md @@ -4,7 +4,7 @@ > **createEventContext**(`init`): [`EventContext`](../types/interfaces/EventContext.md) -Defined in: [packages/events/src/EventContext.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventContext.ts#L18) +Defined in: [packages/events/src/EventContext.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventContext.ts#L18) Create an EventContext from raw event data. diff --git a/en/api/@connectum/events/functions/deriveServiceName.md b/en/api/@connectum/events/functions/deriveServiceName.md index d8fb1f02..b87a230f 100644 --- a/en/api/@connectum/events/functions/deriveServiceName.md +++ b/en/api/@connectum/events/functions/deriveServiceName.md @@ -4,7 +4,7 @@ > **deriveServiceName**(`serviceNames`): `string` \| `undefined` -Defined in: [packages/events/src/EventBus.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/EventBus.ts#L41) +Defined in: [packages/events/src/EventBus.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/EventBus.ts#L42) Derive a service identifier from registered proto service type names. diff --git a/en/api/@connectum/events/functions/dlqMiddleware.md b/en/api/@connectum/events/functions/dlqMiddleware.md index 1419d383..63b1bf8b 100644 --- a/en/api/@connectum/events/functions/dlqMiddleware.md +++ b/en/api/@connectum/events/functions/dlqMiddleware.md @@ -4,7 +4,7 @@ > **dlqMiddleware**(`options`, `adapter`): [`EventMiddleware`](../types/type-aliases/EventMiddleware.md) -Defined in: [packages/events/src/middleware/dlq.ts:29](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/middleware/dlq.ts#L29) +Defined in: [packages/events/src/middleware/dlq.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/middleware/dlq.ts#L29) Create a DLQ middleware that catches errors from inner middleware (retry), publishes to DLQ topic, and acks the original. diff --git a/en/api/@connectum/events/functions/matchPattern.md b/en/api/@connectum/events/functions/matchPattern.md index 0a74e54c..2f2ea4b8 100644 --- a/en/api/@connectum/events/functions/matchPattern.md +++ b/en/api/@connectum/events/functions/matchPattern.md @@ -4,7 +4,7 @@ > **matchPattern**(`pattern`, `topic`): `boolean` -Defined in: [packages/events/src/wildcard.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/wildcard.ts#L27) +Defined in: [packages/events/src/wildcard.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/wildcard.ts#L27) Match a topic against a wildcard pattern. diff --git a/en/api/@connectum/events/functions/resolveTopicName.md b/en/api/@connectum/events/functions/resolveTopicName.md index aea00c1a..7d60bef3 100644 --- a/en/api/@connectum/events/functions/resolveTopicName.md +++ b/en/api/@connectum/events/functions/resolveTopicName.md @@ -4,7 +4,7 @@ > **resolveTopicName**(`method`): `string` -Defined in: [packages/events/src/topic.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/topic.ts#L22) +Defined in: [packages/events/src/topic.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/topic.ts#L22) Resolve the topic name for an event handler method. diff --git a/en/api/@connectum/events/functions/retryMiddleware.md b/en/api/@connectum/events/functions/retryMiddleware.md index c2e18b1f..0d51e899 100644 --- a/en/api/@connectum/events/functions/retryMiddleware.md +++ b/en/api/@connectum/events/functions/retryMiddleware.md @@ -4,7 +4,7 @@ > **retryMiddleware**(`options?`): [`EventMiddleware`](../types/type-aliases/EventMiddleware.md) -Defined in: [packages/events/src/middleware/retry.ts:48](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/middleware/retry.ts#L48) +Defined in: [packages/events/src/middleware/retry.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/middleware/retry.ts#L48) Create a retry middleware with configurable options. diff --git a/en/api/@connectum/events/index.md b/en/api/@connectum/events/index.md index a794bb45..c8256af9 100644 --- a/en/api/@connectum/events/index.md +++ b/en/api/@connectum/events/index.md @@ -12,9 +12,15 @@ - [NonRetryableError](classes/NonRetryableError.md) - [RetryableError](classes/RetryableError.md) +## Interfaces + +- [BroadcastReactor](interfaces/BroadcastReactor.md) +- [BroadcastSubscribersOptions](interfaces/BroadcastSubscribersOptions.md) + ## Functions - [composeMiddleware](functions/composeMiddleware.md) +- [createBroadcastSubscribers](functions/createBroadcastSubscribers.md) - [createEventBus](functions/createEventBus.md) - [createEventContext](functions/createEventContext.md) - [deriveServiceName](functions/deriveServiceName.md) diff --git a/en/api/@connectum/events/interfaces/BroadcastReactor.md b/en/api/@connectum/events/interfaces/BroadcastReactor.md new file mode 100644 index 00000000..fc099440 --- /dev/null +++ b/en/api/@connectum/events/interfaces/BroadcastReactor.md @@ -0,0 +1,37 @@ +[Connectum API Reference](../../../index.md) / [@connectum/events](../index.md) / BroadcastReactor + +# Interface: BroadcastReactor + +Defined in: [packages/events/src/broadcast.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L23) + +One independent broadcast reactor: its consumer group + routes. + +## Properties + +### group + +> `readonly` **group**: `string` + +Defined in: [packages/events/src/broadcast.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L25) + +Consumer group — MUST be DISTINCT per reactor for true fan-out (a shared group load-balances). + +*** + +### middleware? + +> `readonly` `optional` **middleware?**: [`MiddlewareConfig`](../types/interfaces/MiddlewareConfig.md) + +Defined in: [packages/events/src/broadcast.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L29) + +Optional per-reactor middleware (retry/DLQ/custom). + +*** + +### routes + +> `readonly` **routes**: [`EventRoute`](../types/type-aliases/EventRoute.md)[] + +Defined in: [packages/events/src/broadcast.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L27) + +The event routes (handlers) this reactor subscribes with. diff --git a/en/api/@connectum/events/interfaces/BroadcastSubscribersOptions.md b/en/api/@connectum/events/interfaces/BroadcastSubscribersOptions.md new file mode 100644 index 00000000..da16e248 --- /dev/null +++ b/en/api/@connectum/events/interfaces/BroadcastSubscribersOptions.md @@ -0,0 +1,60 @@ +[Connectum API Reference](../../../index.md) / [@connectum/events](../index.md) / BroadcastSubscribersOptions + +# Interface: BroadcastSubscribersOptions + +Defined in: [packages/events/src/broadcast.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L33) + +Options for [createBroadcastSubscribers](../functions/createBroadcastSubscribers.md). + +## Properties + +### adapter + +> `readonly` **adapter**: [`EventAdapter`](../types/interfaces/EventAdapter.md) \| (() => [`EventAdapter`](../types/interfaces/EventAdapter.md)) + +Defined in: [packages/events/src/broadcast.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L40) + +The broker adapter. Pass ONE shared instance (fine for `MemoryAdapter` in +tests, where all buses share the in-memory registry) OR a factory invoked +once per reactor (use this for real brokers so each reactor bus gets its +own connection / durable consumer). + +*** + +### drainTimeout? + +> `readonly` `optional` **drainTimeout?**: `number` + +Defined in: [packages/events/src/broadcast.ts:46](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L46) + +Shared per-bus drain timeout (ms). + +*** + +### handlerTimeout? + +> `readonly` `optional` **handlerTimeout?**: `number` + +Defined in: [packages/events/src/broadcast.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L44) + +Shared per-bus handler timeout (ms). + +*** + +### reactors + +> `readonly` **reactors**: [`BroadcastReactor`](BroadcastReactor.md)[] + +Defined in: [packages/events/src/broadcast.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L42) + +The independent reactors — each becomes its own EventBus with its own group. + +*** + +### signal? + +> `readonly` `optional` **signal?**: `AbortSignal` + +Defined in: [packages/events/src/broadcast.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/broadcast.ts#L48) + +Shared abort signal for graceful shutdown. diff --git a/en/api/@connectum/events/types/interfaces/AdapterContext.md b/en/api/@connectum/events/types/interfaces/AdapterContext.md index 2855600a..15c3cf89 100644 --- a/en/api/@connectum/events/types/interfaces/AdapterContext.md +++ b/en/api/@connectum/events/types/interfaces/AdapterContext.md @@ -2,7 +2,7 @@ # Interface: AdapterContext -Defined in: [packages/events/src/types.ts:78](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L78) +Defined in: [packages/events/src/types.ts:78](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L78) Context provided to adapters by the EventBus before connect(). @@ -17,7 +17,7 @@ Redis connectionName). > `readonly` `optional` **serviceName?**: `string` -Defined in: [packages/events/src/types.ts:88](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L88) +Defined in: [packages/events/src/types.ts:88](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L88) Service identifier derived from proto service names. diff --git a/en/api/@connectum/events/types/interfaces/DlqOptions.md b/en/api/@connectum/events/types/interfaces/DlqOptions.md index cb59b273..5dc2da5c 100644 --- a/en/api/@connectum/events/types/interfaces/DlqOptions.md +++ b/en/api/@connectum/events/types/interfaces/DlqOptions.md @@ -2,7 +2,7 @@ # Interface: DlqOptions -Defined in: [packages/events/src/types.ts:267](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L267) +Defined in: [packages/events/src/types.ts:267](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L267) Dead letter queue middleware options @@ -12,7 +12,7 @@ Dead letter queue middleware options > `optional` **errorSerializer?**: (`error`) => `string` -Defined in: [packages/events/src/types.ts:276](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L276) +Defined in: [packages/events/src/types.ts:276](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L276) Custom error serializer for DLQ metadata. Defaults to `error.name` only (e.g. "TypeError") to prevent credential leaks. @@ -35,6 +35,6 @@ For production, provide a custom serializer that redacts sensitive data > **topic**: `string` -Defined in: [packages/events/src/types.ts:269](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L269) +Defined in: [packages/events/src/types.ts:269](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L269) DLQ topic name diff --git a/en/api/@connectum/events/types/interfaces/EventAdapter.md b/en/api/@connectum/events/types/interfaces/EventAdapter.md index ec128fd7..fbd3a55b 100644 --- a/en/api/@connectum/events/types/interfaces/EventAdapter.md +++ b/en/api/@connectum/events/types/interfaces/EventAdapter.md @@ -2,7 +2,7 @@ # Interface: EventAdapter -Defined in: [packages/events/src/types.ts:97](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L97) +Defined in: [packages/events/src/types.ts:97](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L97) Minimal adapter interface for message brokers. @@ -15,7 +15,7 @@ config in constructor, not in interface methods. > `readonly` **name**: `string` -Defined in: [packages/events/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L99) +Defined in: [packages/events/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L99) Adapter name for identification (e.g., "nats", "kafka", "redis", "memory") @@ -25,7 +25,7 @@ Adapter name for identification (e.g., "nats", "kafka", "redis", "memory") > **connect**(`context?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L108) +Defined in: [packages/events/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L108) Connect to the message broker. @@ -49,7 +49,7 @@ Optional adapter context with service-level information > **disconnect**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:111](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L111) +Defined in: [packages/events/src/types.ts:111](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L111) Disconnect from the message broker @@ -63,7 +63,7 @@ Disconnect from the message broker > **publish**(`eventType`, `payload`, `options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:114](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L114) +Defined in: [packages/events/src/types.ts:114](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L114) Publish a serialized event to a topic @@ -91,7 +91,7 @@ Publish a serialized event to a topic > **subscribe**(`patterns`, `handler`, `options?`): `Promise`\<[`EventSubscription`](EventSubscription.md)\> -Defined in: [packages/events/src/types.ts:117](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L117) +Defined in: [packages/events/src/types.ts:117](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L117) Subscribe to event patterns with a raw handler diff --git a/en/api/@connectum/events/types/interfaces/EventBus.md b/en/api/@connectum/events/types/interfaces/EventBus.md index 1597f03c..fd79f489 100644 --- a/en/api/@connectum/events/types/interfaces/EventBus.md +++ b/en/api/@connectum/events/types/interfaces/EventBus.md @@ -2,7 +2,7 @@ # Interface: EventBus -Defined in: [packages/events/src/types.ts:331](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L331) +Defined in: [packages/events/src/types.ts:357](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L357) EventBus interface -- manages adapter, routes, and middleware @@ -12,7 +12,7 @@ EventBus interface -- manages adapter, routes, and middleware > **publish**\<`Desc`\>(`schema`, `data`, `options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:345](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L345) +Defined in: [packages/events/src/types.ts:371](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L371) Publish a typed event @@ -46,7 +46,7 @@ Publish a typed event > **start**(`options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:341](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L341) +Defined in: [packages/events/src/types.ts:367](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L367) Start the event bus: connect adapter, set up subscriptions. @@ -74,7 +74,7 @@ shutdown or per-event timeout will abort in-flight processing. > **stop**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L343) +Defined in: [packages/events/src/types.ts:369](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L369) Stop the event bus: drain subscriptions, disconnect adapter diff --git a/en/api/@connectum/events/types/interfaces/EventBusOptions.md b/en/api/@connectum/events/types/interfaces/EventBusOptions.md index e0371eb7..c24392ab 100644 --- a/en/api/@connectum/events/types/interfaces/EventBusOptions.md +++ b/en/api/@connectum/events/types/interfaces/EventBusOptions.md @@ -2,7 +2,7 @@ # Interface: EventBusOptions -Defined in: [packages/events/src/types.ts:294](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L294) +Defined in: [packages/events/src/types.ts:294](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L294) EventBus configuration options for createEventBus() @@ -12,7 +12,7 @@ EventBus configuration options for createEventBus() > **adapter**: [`EventAdapter`](EventAdapter.md) -Defined in: [packages/events/src/types.ts:296](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L296) +Defined in: [packages/events/src/types.ts:296](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L296) Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter) @@ -22,7 +22,7 @@ Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter) > `optional` **drainTimeout?**: `number` -Defined in: [packages/events/src/types.ts:325](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L325) +Defined in: [packages/events/src/types.ts:337](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L337) Maximum time in milliseconds to wait for in-flight event handlers to complete during shutdown. After this timeout, remaining handlers @@ -36,7 +36,7 @@ Default: 30000 (30 seconds). Set to 0 for immediate abort. > `optional` **group?**: `string` -Defined in: [packages/events/src/types.ts:300](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L300) +Defined in: [packages/events/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L312) Consumer group name @@ -46,7 +46,7 @@ Consumer group name > `optional` **handlerTimeout?**: `number` -Defined in: [packages/events/src/types.ts:317](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L317) +Defined in: [packages/events/src/types.ts:329](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L329) Per-event handler timeout in milliseconds. @@ -59,17 +59,35 @@ this duration. Default: 30000 (30 seconds). > `optional` **middleware?**: [`MiddlewareConfig`](MiddlewareConfig.md) -Defined in: [packages/events/src/types.ts:302](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L302) +Defined in: [packages/events/src/types.ts:314](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L314) Middleware configuration *** +### publishes? + +> `optional` **publishes?**: `DescService`[] + +Defined in: [packages/events/src/types.ts:310](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L310) + +Event service descriptors this bus publishes to (publish-only, no subscription). + +A process that only PUBLISHES events has no `routes`, so its publish-topic +lookup would be empty and `publish()` would fall back to the message +`typeName` — silently emitting to the wrong topic whenever the event +declares a custom `(connectum.events.v1.event).topic`. List the event +service descriptors here to populate the publish-topic lookup from their +proto options, so the declared topic is used end-to-end without +hand-maintaining raw topic strings. Subscribers still register via `routes`. + +*** + ### routes? > `optional` **routes?**: [`EventRoute`](../type-aliases/EventRoute.md)[] -Defined in: [packages/events/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L298) +Defined in: [packages/events/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L298) Event routes to register @@ -79,10 +97,30 @@ Event routes to register > `optional` **signal?**: `AbortSignal` -Defined in: [packages/events/src/types.ts:310](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L310) +Defined in: [packages/events/src/types.ts:322](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L322) Abort signal for graceful shutdown. When provided, per-event signals are composed via `AbortSignal.any()` so that server shutdown aborts in-flight event processing. Automatically set when used with `createServer({ eventBus })`. + +*** + +### strictTopics? + +> `optional` **strictTopics?**: `boolean` + +Defined in: [packages/events/src/types.ts:351](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L351) + +Reject a `publish()` whose topic cannot be resolved instead of silently +falling back to the message `typeName`. + +By default, when no explicit `publishOptions.topic` is given and the event +type is covered by neither `routes` nor `publishes`, `publish()` emits to +the raw `schema.typeName` — a silent misconfiguration (the event may never +reach subscribers expecting the proto-declared `(event).topic`). With +`strictTopics: true`, that case throws so the misconfiguration surfaces at +the call site. + +Default: `false` (backward-compatible silent fallback). diff --git a/en/api/@connectum/events/types/interfaces/EventContext.md b/en/api/@connectum/events/types/interfaces/EventContext.md index f7746813..2d1ce839 100644 --- a/en/api/@connectum/events/types/interfaces/EventContext.md +++ b/en/api/@connectum/events/types/interfaces/EventContext.md @@ -2,7 +2,7 @@ # Interface: EventContext -Defined in: [packages/events/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L131) +Defined in: [packages/events/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L131) Per-event context with explicit ack/nack control. @@ -16,7 +16,7 @@ without calling either, the event is automatically acknowledged. > `readonly` **attempt**: `number` -Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L141) +Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L141) Delivery attempt number (1-based) @@ -26,7 +26,7 @@ Delivery attempt number (1-based) > `readonly` **eventId**: `string` -Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L135) +Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L135) Unique event identifier @@ -36,7 +36,7 @@ Unique event identifier > `readonly` **eventType**: `string` -Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L137) +Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L137) Event type / topic name @@ -46,7 +46,7 @@ Event type / topic name > `readonly` **metadata**: `ReadonlyMap`\<`string`, `string`\> -Defined in: [packages/events/src/types.ts:143](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L143) +Defined in: [packages/events/src/types.ts:143](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L143) Event metadata (headers) @@ -56,7 +56,7 @@ Event metadata (headers) > `readonly` **publishedAt**: `Date` -Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L139) +Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L139) When the event was published @@ -66,7 +66,7 @@ When the event was published > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L133) +Defined in: [packages/events/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L133) Abort signal (aborted when server is shutting down) @@ -76,7 +76,7 @@ Abort signal (aborted when server is shutting down) > **ack**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L145) +Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L145) Acknowledge successful processing @@ -90,7 +90,7 @@ Acknowledge successful processing > **nack**(`requeue?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L147) +Defined in: [packages/events/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L147) Negative acknowledge -- request redelivery or send to DLQ diff --git a/en/api/@connectum/events/types/interfaces/EventContextInit.md b/en/api/@connectum/events/types/interfaces/EventContextInit.md index 6f670f48..c3f748c3 100644 --- a/en/api/@connectum/events/types/interfaces/EventContextInit.md +++ b/en/api/@connectum/events/types/interfaces/EventContextInit.md @@ -2,7 +2,7 @@ # Interface: EventContextInit -Defined in: [packages/events/src/types.ts:153](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L153) +Defined in: [packages/events/src/types.ts:153](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L153) Initialization data for creating an EventContext @@ -12,7 +12,7 @@ Initialization data for creating an EventContext > `readonly` **onAck**: () => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L156) +Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L156) #### Returns @@ -24,7 +24,7 @@ Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Fram > `readonly` **onNack**: (`requeue`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L157) +Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L157) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Fram > `readonly` **raw**: [`RawEvent`](RawEvent.md) -Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L154) +Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L154) *** @@ -50,4 +50,4 @@ Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Fram > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:155](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L155) +Defined in: [packages/events/src/types.ts:155](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L155) diff --git a/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md b/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md index 292f2f5e..2d5ff56f 100644 --- a/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md +++ b/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md @@ -2,7 +2,7 @@ # Interface: EventHandlerConfig\ -Defined in: [packages/events/src/types.ts:176](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L176) +Defined in: [packages/events/src/types.ts:176](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L176) Per-handler middleware configuration. @@ -22,7 +22,7 @@ and only the per-handler middleware array is applied. > `readonly` **handler**: [`TypedEventHandler`](../type-aliases/TypedEventHandler.md)\<`I`\> -Defined in: [packages/events/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L178) +Defined in: [packages/events/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L178) Event handler function @@ -32,6 +32,6 @@ Event handler function > `readonly` `optional` **middleware?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[] -Defined in: [packages/events/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L180) +Defined in: [packages/events/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L180) Per-handler middleware array (overrides global middleware for this handler) diff --git a/en/api/@connectum/events/types/interfaces/EventRouteEntry.md b/en/api/@connectum/events/types/interfaces/EventRouteEntry.md index b3487280..61bda8c5 100644 --- a/en/api/@connectum/events/types/interfaces/EventRouteEntry.md +++ b/en/api/@connectum/events/types/interfaces/EventRouteEntry.md @@ -2,7 +2,7 @@ # Interface: EventRouteEntry -Defined in: [packages/events/src/types.ts:197](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L197) +Defined in: [packages/events/src/types.ts:197](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L197) Registered event route (internal use) @@ -12,7 +12,7 @@ Registered event route (internal use) > `readonly` **handler**: [`TypedEventHandler`](../type-aliases/TypedEventHandler.md)\<`unknown`\> -Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L203) +Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L203) Typed handler function @@ -22,7 +22,7 @@ Typed handler function > `readonly` **method**: `DescMethod` -Defined in: [packages/events/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L201) +Defined in: [packages/events/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L201) Method descriptor for deserialization @@ -32,7 +32,7 @@ Method descriptor for deserialization > `readonly` `optional` **middleware?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[] -Defined in: [packages/events/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L205) +Defined in: [packages/events/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L205) Per-handler middleware (overrides global when present) @@ -42,6 +42,6 @@ Per-handler middleware (overrides global when present) > `readonly` **topic**: `string` -Defined in: [packages/events/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L199) +Defined in: [packages/events/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L199) Topic pattern to subscribe to diff --git a/en/api/@connectum/events/types/interfaces/EventRouter.md b/en/api/@connectum/events/types/interfaces/EventRouter.md index 918857dc..286f090b 100644 --- a/en/api/@connectum/events/types/interfaces/EventRouter.md +++ b/en/api/@connectum/events/types/interfaces/EventRouter.md @@ -2,7 +2,7 @@ # Interface: EventRouter -Defined in: [packages/events/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L214) +Defined in: [packages/events/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L214) Event router for registering service event handlers. @@ -15,7 +15,7 @@ Mirrors ConnectRPC's ConnectRouter pattern: > **service**\<`S`\>(`serviceDesc`, `handlers`): `void` -Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L216) +Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L216) Register event handlers for a service diff --git a/en/api/@connectum/events/types/interfaces/EventSubscription.md b/en/api/@connectum/events/types/interfaces/EventSubscription.md index 23ccbe76..8d258922 100644 --- a/en/api/@connectum/events/types/interfaces/EventSubscription.md +++ b/en/api/@connectum/events/types/interfaces/EventSubscription.md @@ -2,7 +2,7 @@ # Interface: EventSubscription -Defined in: [packages/events/src/types.ts:43](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L43) +Defined in: [packages/events/src/types.ts:43](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L43) Subscription handle returned by adapter.subscribe() @@ -12,7 +12,7 @@ Subscription handle returned by adapter.subscribe() > **unsubscribe**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:45](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L45) +Defined in: [packages/events/src/types.ts:45](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L45) Unsubscribe and clean up diff --git a/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md b/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md index 7cb5b7a8..b819cff8 100644 --- a/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md +++ b/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md @@ -2,7 +2,7 @@ # Interface: MiddlewareConfig -Defined in: [packages/events/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L282) +Defined in: [packages/events/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L282) Built-in middleware configuration @@ -12,7 +12,7 @@ Built-in middleware configuration > `optional` **custom?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[] -Defined in: [packages/events/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L288) +Defined in: [packages/events/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L288) Custom user middleware (executed outermost) @@ -22,7 +22,7 @@ Custom user middleware (executed outermost) > `optional` **dlq?**: [`DlqOptions`](DlqOptions.md) -Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L286) +Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L286) Dead letter queue configuration @@ -32,6 +32,6 @@ Dead letter queue configuration > `optional` **retry?**: [`RetryOptions`](RetryOptions.md) -Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L284) +Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L284) Retry configuration diff --git a/en/api/@connectum/events/types/interfaces/PublishOptions.md b/en/api/@connectum/events/types/interfaces/PublishOptions.md index 283f8de0..4318e71c 100644 --- a/en/api/@connectum/events/types/interfaces/PublishOptions.md +++ b/en/api/@connectum/events/types/interfaces/PublishOptions.md @@ -2,7 +2,7 @@ # Interface: PublishOptions -Defined in: [packages/events/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L59) +Defined in: [packages/events/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L59) Options for publishing events @@ -12,7 +12,7 @@ Options for publishing events > `optional` **group?**: `string` -Defined in: [packages/events/src/types.ts:63](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L63) +Defined in: [packages/events/src/types.ts:63](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L63) Named group tag for workflow grouping @@ -22,7 +22,7 @@ Named group tag for workflow grouping > `optional` **key?**: `string` -Defined in: [packages/events/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L67) +Defined in: [packages/events/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L67) Message key for partitioning (Kafka: partition key, others: ignored) @@ -32,7 +32,7 @@ Message key for partitioning (Kafka: partition key, others: ignored) > `optional` **metadata?**: `Record`\<`string`, `string`\> -Defined in: [packages/events/src/types.ts:65](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L65) +Defined in: [packages/events/src/types.ts:65](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L65) Additional metadata / headers @@ -42,6 +42,6 @@ Additional metadata / headers > `optional` **topic?**: `string` -Defined in: [packages/events/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L61) +Defined in: [packages/events/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L61) Override topic name (default: schema.typeName) diff --git a/en/api/@connectum/events/types/interfaces/RawEvent.md b/en/api/@connectum/events/types/interfaces/RawEvent.md index bfc3444f..9f8422ea 100644 --- a/en/api/@connectum/events/types/interfaces/RawEvent.md +++ b/en/api/@connectum/events/types/interfaces/RawEvent.md @@ -2,7 +2,7 @@ # Interface: RawEvent -Defined in: [packages/events/src/types.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L16) +Defined in: [packages/events/src/types.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L16) Raw event data delivered by the adapter @@ -12,7 +12,7 @@ Raw event data delivered by the adapter > `readonly` **attempt**: `number` -Defined in: [packages/events/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L26) +Defined in: [packages/events/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L26) Delivery attempt number (1-based) @@ -22,7 +22,7 @@ Delivery attempt number (1-based) > `readonly` **eventId**: `string` -Defined in: [packages/events/src/types.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L18) +Defined in: [packages/events/src/types.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L18) Unique event identifier @@ -32,7 +32,7 @@ Unique event identifier > `readonly` **eventType**: `string` -Defined in: [packages/events/src/types.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L20) +Defined in: [packages/events/src/types.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L20) Event type / topic name @@ -42,7 +42,7 @@ Event type / topic name > `readonly` **metadata**: `ReadonlyMap`\<`string`, `string`\> -Defined in: [packages/events/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L28) +Defined in: [packages/events/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L28) Event metadata (headers) @@ -52,7 +52,7 @@ Event metadata (headers) > `readonly` **payload**: `Uint8Array` -Defined in: [packages/events/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L22) +Defined in: [packages/events/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L22) Serialized protobuf payload @@ -62,6 +62,6 @@ Serialized protobuf payload > `readonly` **publishedAt**: `Date` -Defined in: [packages/events/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L24) +Defined in: [packages/events/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L24) When the event was published diff --git a/en/api/@connectum/events/types/interfaces/RawSubscribeOptions.md b/en/api/@connectum/events/types/interfaces/RawSubscribeOptions.md index 48d6e1e1..a9b35f95 100644 --- a/en/api/@connectum/events/types/interfaces/RawSubscribeOptions.md +++ b/en/api/@connectum/events/types/interfaces/RawSubscribeOptions.md @@ -2,7 +2,7 @@ # Interface: RawSubscribeOptions -Defined in: [packages/events/src/types.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L51) +Defined in: [packages/events/src/types.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L51) Options for raw subscribe @@ -12,6 +12,6 @@ Options for raw subscribe > `optional` **group?**: `string` -Defined in: [packages/events/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L53) +Defined in: [packages/events/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L53) Consumer group name for load-balanced consumption diff --git a/en/api/@connectum/events/types/interfaces/RetryOptions.md b/en/api/@connectum/events/types/interfaces/RetryOptions.md index 3c6d1a3d..9122dcb3 100644 --- a/en/api/@connectum/events/types/interfaces/RetryOptions.md +++ b/en/api/@connectum/events/types/interfaces/RetryOptions.md @@ -2,7 +2,7 @@ # Interface: RetryOptions -Defined in: [packages/events/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L249) +Defined in: [packages/events/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L249) Retry middleware options @@ -12,7 +12,7 @@ Retry middleware options > `optional` **backoff?**: `"fixed"` \| `"exponential"` \| `"linear"` -Defined in: [packages/events/src/types.ts:253](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L253) +Defined in: [packages/events/src/types.ts:253](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L253) Backoff strategy @@ -22,7 +22,7 @@ Backoff strategy > `optional` **initialDelay?**: `number` -Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L255) +Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L255) Initial delay in ms (default: 1000) @@ -32,7 +32,7 @@ Initial delay in ms (default: 1000) > `optional` **maxDelay?**: `number` -Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L257) +Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L257) Maximum delay in ms (default: 30000) @@ -42,7 +42,7 @@ Maximum delay in ms (default: 30000) > `optional` **maxRetries?**: `number` -Defined in: [packages/events/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L251) +Defined in: [packages/events/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L251) Maximum retry attempts (default: 3) @@ -52,7 +52,7 @@ Maximum retry attempts (default: 3) > `optional` **multiplier?**: `number` -Defined in: [packages/events/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L259) +Defined in: [packages/events/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L259) Multiplier for exponential backoff (default: 2) @@ -62,7 +62,7 @@ Multiplier for exponential backoff (default: 2) > `optional` **retryableErrors?**: (`error`) => `boolean` -Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L261) +Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L261) Filter: only retry for these error types diff --git a/en/api/@connectum/events/types/type-aliases/EventMiddleware.md b/en/api/@connectum/events/types/type-aliases/EventMiddleware.md index deeac966..c1a0672e 100644 --- a/en/api/@connectum/events/types/type-aliases/EventMiddleware.md +++ b/en/api/@connectum/events/types/type-aliases/EventMiddleware.md @@ -4,7 +4,7 @@ > **EventMiddleware** = (`event`, `ctx`, `next`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:240](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L240) +Defined in: [packages/events/src/types.ts:240](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L240) Event middleware function diff --git a/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md b/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md index b0ebb944..69aef3aa 100644 --- a/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md +++ b/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md @@ -4,7 +4,7 @@ > **EventMiddlewareNext** = (`updatedEvent?`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L235) +Defined in: [packages/events/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L235) Event middleware next function. diff --git a/en/api/@connectum/events/types/type-aliases/EventRoute.md b/en/api/@connectum/events/types/type-aliases/EventRoute.md index 4a36305c..a98a8a11 100644 --- a/en/api/@connectum/events/types/type-aliases/EventRoute.md +++ b/en/api/@connectum/events/types/type-aliases/EventRoute.md @@ -4,7 +4,7 @@ > **EventRoute** = (`events`) => `void` -Defined in: [packages/events/src/types.ts:222](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L222) +Defined in: [packages/events/src/types.ts:222](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L222) Event route function -- mirrors ServiceRoute from @connectum/core diff --git a/en/api/@connectum/events/types/type-aliases/RawEventHandler.md b/en/api/@connectum/events/types/type-aliases/RawEventHandler.md index 19cbb766..150c0261 100644 --- a/en/api/@connectum/events/types/type-aliases/RawEventHandler.md +++ b/en/api/@connectum/events/types/type-aliases/RawEventHandler.md @@ -4,7 +4,7 @@ > **RawEventHandler** = (`event`, `ack`, `nack`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L38) +Defined in: [packages/events/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L38) Raw event handler function type. diff --git a/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md b/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md index 79ec94fb..180f6403 100644 --- a/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md +++ b/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md @@ -4,7 +4,7 @@ > **ServiceEventHandlers**\<`S`\> = \{ \[K in keyof S\["method"\]\]: TypedEventHandler\\> \| EventHandlerConfig\\> \} -Defined in: [packages/events/src/types.ts:190](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L190) +Defined in: [packages/events/src/types.ts:190](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L190) Maps service methods to typed event handlers. diff --git a/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md b/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md index e7150c78..0942cead 100644 --- a/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md +++ b/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md @@ -4,7 +4,7 @@ > **TypedEventHandler**\<`I`\> = (`event`, `ctx`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:167](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/events/src/types.ts#L167) +Defined in: [packages/events/src/types.ts:167](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L167) Typed event handler for a specific message type diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/classes/HealthcheckManager.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/classes/HealthcheckManager.md index b19ba35e..2fdf017f 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/classes/HealthcheckManager.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/classes/HealthcheckManager.md @@ -2,7 +2,7 @@ # Class: HealthcheckManager -Defined in: [HealthcheckManager.ts:79](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L79) +Defined in: [HealthcheckManager.ts:79](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L79) Healthcheck manager @@ -45,7 +45,7 @@ server.on('stopping', () => healthcheckManager.set('process', ServingStatus.NOT_ > **areAllHealthy**(): `boolean` -Defined in: [HealthcheckManager.ts:206](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L206) +Defined in: [HealthcheckManager.ts:206](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L206) Check if all services and components are healthy (SERVING) @@ -61,7 +61,7 @@ True if all entries are SERVING; false for an empty registry > **clear**(): `void` -Defined in: [HealthcheckManager.ts:254](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L254) +Defined in: [HealthcheckManager.ts:254](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L254) Clear all services and components @@ -75,7 +75,7 @@ Clear all services and components > **getAllStatuses**(): `Map`\<`string`, [`ServiceStatus`](../types/interfaces/ServiceStatus.md)\> -Defined in: [HealthcheckManager.ts:193](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L193) +Defined in: [HealthcheckManager.ts:193](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L193) Get all services health status @@ -91,7 +91,7 @@ Map of service/component name to health status > **getStatus**(`service`): [`ServiceStatus`](../types/interfaces/ServiceStatus.md) \| `undefined` -Defined in: [HealthcheckManager.ts:183](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L183) +Defined in: [HealthcheckManager.ts:183](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L183) Get service health status @@ -115,7 +115,7 @@ Service status or undefined if not found > **initialize**(`serviceNames`): `void` -Defined in: [HealthcheckManager.ts:229](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L229) +Defined in: [HealthcheckManager.ts:229](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L229) Initialize the RPC service slice of the registry. @@ -148,7 +148,7 @@ Array of RPC service typeNames to track > **register**(`component`, `initialStatus?`): `void` -Defined in: [HealthcheckManager.ts:123](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L123) +Defined in: [HealthcheckManager.ts:123](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L123) Register an application health component. @@ -185,7 +185,7 @@ Error on invalid name or when the name belongs to an RPC service > **set**(`component`, `status`): `void` -Defined in: [HealthcheckManager.ts:149](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L149) +Defined in: [HealthcheckManager.ts:149](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L149) Set a component's status (upsert). @@ -221,7 +221,7 @@ Error on invalid name or when the name belongs to an RPC service > **unregister**(`component`): `void` -Defined in: [HealthcheckManager.ts:166](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L166) +Defined in: [HealthcheckManager.ts:166](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L166) Remove a registered component. @@ -247,7 +247,7 @@ Error when the name belongs to an RPC service > **update**(`status`, `service?`): `void` -Defined in: [HealthcheckManager.ts:93](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L93) +Defined in: [HealthcheckManager.ts:93](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L93) Update service health status diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/Healthcheck.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/Healthcheck.md index c64596e5..fd95e1dd 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/Healthcheck.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/Healthcheck.md @@ -4,7 +4,7 @@ > **Healthcheck**(`options?`): `ProtocolRegistration` -Defined in: [Healthcheck.ts:84](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/Healthcheck.ts#L84) +Defined in: [Healthcheck.ts:84](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/Healthcheck.ts#L84) Create healthcheck protocol registration diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHealthcheckManager.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHealthcheckManager.md index cb8833e4..e1fc45ca 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHealthcheckManager.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHealthcheckManager.md @@ -4,7 +4,7 @@ > **createHealthcheckManager**(): [`HealthcheckManager`](../classes/HealthcheckManager.md) -Defined in: [HealthcheckManager.ts:264](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/HealthcheckManager.ts#L264) +Defined in: [HealthcheckManager.ts:264](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/HealthcheckManager.ts#L264) Create a new isolated HealthcheckManager instance diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHttpHealthHandler.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHttpHealthHandler.md index f1172556..0bee4afb 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHttpHealthHandler.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHttpHealthHandler.md @@ -4,7 +4,7 @@ > **createHttpHealthHandler**(`manager`, `healthPaths?`): `HttpHandler` -Defined in: [httpHandler.ts:58](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/httpHandler.ts#L58) +Defined in: [httpHandler.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/httpHandler.ts#L58) Create HTTP health handler that mirrors gRPC healthcheck status diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/parseServiceFromUrl.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/parseServiceFromUrl.md index fc4cf495..2afbb7d0 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/parseServiceFromUrl.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/parseServiceFromUrl.md @@ -4,7 +4,7 @@ > **parseServiceFromUrl**(`url`, `host`): `string` \| `undefined` -Defined in: [httpHandler.ts:111](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/httpHandler.ts#L111) +Defined in: [httpHandler.ts:111](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/httpHandler.ts#L111) Parse service name from URL query string diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/HealthcheckOptions.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/HealthcheckOptions.md index 58c3a6dc..d04fa2e1 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/HealthcheckOptions.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/HealthcheckOptions.md @@ -2,7 +2,7 @@ # Interface: HealthcheckOptions -Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L27) Healthcheck protocol options @@ -12,7 +12,7 @@ Healthcheck protocol options > `optional` **httpEnabled?**: `boolean` -Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L32) Enable HTTP health endpoints @@ -28,7 +28,7 @@ false > `optional` **httpPaths?**: `string`[] -Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L38) HTTP health endpoint paths that all respond with health status. @@ -44,7 +44,7 @@ HTTP health endpoint paths that all respond with health status. > `optional` **manager?**: [`HealthcheckManager`](../../classes/HealthcheckManager.md) -Defined in: [types.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L51) +Defined in: [types.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L51) Custom HealthcheckManager instance. Useful for testing or running multiple servers in one process. @@ -56,7 +56,7 @@ When not provided, uses the default module-level singleton. > `optional` **watchInterval?**: `number` -Defined in: [types.ts:44](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L44) +Defined in: [types.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L44) Watch interval in milliseconds for streaming health updates diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/ServiceStatus.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/ServiceStatus.md index 04d50b62..a7979c8b 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/ServiceStatus.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/ServiceStatus.md @@ -2,7 +2,7 @@ # Interface: ServiceStatus -Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L20) +Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L20) Service health status @@ -12,4 +12,4 @@ Service health status > **status**: `HealthCheckResponse_ServingStatus` -Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L21) diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/type-aliases/ServingStatus.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/type-aliases/ServingStatus.md index 179fbce1..8fc37a14 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/type-aliases/ServingStatus.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/type-aliases/ServingStatus.md @@ -4,7 +4,7 @@ > **ServingStatus** = `HealthCheckResponse_ServingStatus` -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L14) Service serving status diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/variables/ServingStatus.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/variables/ServingStatus.md index e20fe664..d272bc73 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/types/variables/ServingStatus.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/types/variables/ServingStatus.md @@ -4,7 +4,7 @@ > `const` **ServingStatus**: *typeof* `HealthCheckResponse_ServingStatus` = `HealthCheckResponse_ServingStatus` -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/types.ts#L14) Service serving status diff --git a/en/api/@connectum/healthcheck/@connectum/healthcheck/variables/healthcheckManager.md b/en/api/@connectum/healthcheck/@connectum/healthcheck/variables/healthcheckManager.md index d32b0ba0..c9697539 100644 --- a/en/api/@connectum/healthcheck/@connectum/healthcheck/variables/healthcheckManager.md +++ b/en/api/@connectum/healthcheck/@connectum/healthcheck/variables/healthcheckManager.md @@ -4,7 +4,7 @@ > `const` **healthcheckManager**: [`HealthcheckManager`](../classes/HealthcheckManager.md) -Defined in: [Healthcheck.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/healthcheck/src/Healthcheck.ts#L41) +Defined in: [Healthcheck.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/healthcheck/src/Healthcheck.ts#L41) Module-level singleton health manager diff --git a/en/api/@connectum/interceptors/bulkhead/functions/createBulkheadInterceptor.md b/en/api/@connectum/interceptors/bulkhead/functions/createBulkheadInterceptor.md index 593519b3..a12f791f 100644 --- a/en/api/@connectum/interceptors/bulkhead/functions/createBulkheadInterceptor.md +++ b/en/api/@connectum/interceptors/bulkhead/functions/createBulkheadInterceptor.md @@ -4,7 +4,7 @@ > **createBulkheadInterceptor**(`options?`): `Interceptor` -Defined in: [bulkhead.ts:56](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/bulkhead.ts#L56) +Defined in: [bulkhead.ts:56](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/bulkhead.ts#L56) Create bulkhead interceptor diff --git a/en/api/@connectum/interceptors/circuit-breaker/functions/createCircuitBreakerInterceptor.md b/en/api/@connectum/interceptors/circuit-breaker/functions/createCircuitBreakerInterceptor.md index 27f0d415..8cba4798 100644 --- a/en/api/@connectum/interceptors/circuit-breaker/functions/createCircuitBreakerInterceptor.md +++ b/en/api/@connectum/interceptors/circuit-breaker/functions/createCircuitBreakerInterceptor.md @@ -4,7 +4,7 @@ > **createCircuitBreakerInterceptor**(`options?`): `Interceptor` -Defined in: [circuit-breaker.ts:94](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/circuit-breaker.ts#L94) +Defined in: [circuit-breaker.ts:94](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/circuit-breaker.ts#L94) Create circuit breaker interceptor diff --git a/en/api/@connectum/interceptors/circuit-breaker/functions/defaultFailurePredicate.md b/en/api/@connectum/interceptors/circuit-breaker/functions/defaultFailurePredicate.md index 36980fc5..3a2e3abd 100644 --- a/en/api/@connectum/interceptors/circuit-breaker/functions/defaultFailurePredicate.md +++ b/en/api/@connectum/interceptors/circuit-breaker/functions/defaultFailurePredicate.md @@ -4,7 +4,7 @@ > **defaultFailurePredicate**(`error`): `boolean` -Defined in: [circuit-breaker.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/circuit-breaker.ts#L37) +Defined in: [circuit-breaker.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/circuit-breaker.ts#L37) Default circuit-failure classification. diff --git a/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md b/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md index a6c4b0ec..420daf84 100644 --- a/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md +++ b/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md @@ -4,7 +4,7 @@ > **createDefaultInterceptors**(`options?`): `Interceptor`[] -Defined in: [defaults.ts:156](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L156) +Defined in: [defaults.ts:156](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L156) ## Parameters diff --git a/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md b/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md index a507e2e8..2e647145 100644 --- a/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md +++ b/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: DefaultInterceptorOptions -Defined in: [defaults.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L39) +Defined in: [defaults.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L39) Configuration options for the default interceptor chain. @@ -24,7 +24,7 @@ errors). Enable each one explicitly where you need it. > `optional` **bulkhead?**: `boolean` \| [`BulkheadOptions`](../../interfaces/BulkheadOptions.md) -Defined in: [defaults.ts:61](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L61) +Defined in: [defaults.ts:61](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L61) Bulkhead interceptor. Limits concurrent requests to prevent resource exhaustion. @@ -42,7 +42,7 @@ false > `optional` **circuitBreaker?**: `boolean` \| [`CircuitBreakerOptions`](../../interfaces/CircuitBreakerOptions.md) -Defined in: [defaults.ts:70](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L70) +Defined in: [defaults.ts:70](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L70) Circuit breaker interceptor. Prevents cascading failures by breaking circuit on consecutive errors. @@ -61,7 +61,7 @@ false > `optional` **errorHandler?**: `boolean` \| [`ErrorHandlerOptions`](../../interfaces/ErrorHandlerOptions.md) -Defined in: [defaults.ts:45](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L45) +Defined in: [defaults.ts:45](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L45) Error handler interceptor (first in chain). Transforms errors into ConnectError with proper codes. @@ -78,7 +78,7 @@ true > `optional` **fallback?**: `boolean` \| [`FallbackOptions`](../../interfaces/FallbackOptions.md)\<`unknown`\> -Defined in: [defaults.ts:86](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L86) +Defined in: [defaults.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L86) Fallback interceptor. Provides graceful degradation when service fails. @@ -96,7 +96,7 @@ false > `optional` **retry?**: `boolean` \| [`RetryOptions`](../../interfaces/RetryOptions.md) -Defined in: [defaults.ts:78](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L78) +Defined in: [defaults.ts:78](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L78) Retry interceptor. Retries transient failures with exponential backoff. @@ -114,7 +114,7 @@ false > `optional` **serializer?**: `boolean` \| [`SerializerOptions`](../../interfaces/SerializerOptions.md) -Defined in: [defaults.ts:101](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L101) +Defined in: [defaults.ts:101](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L101) Serializer interceptor (last in chain). Auto JSON serialization for ConnectRPC responses. @@ -132,7 +132,7 @@ false > `optional` **timeout?**: `boolean` \| [`TimeoutOptions`](../../interfaces/TimeoutOptions.md) -Defined in: [defaults.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L53) +Defined in: [defaults.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L53) Timeout interceptor. Enforces request deadline before any processing. @@ -150,7 +150,7 @@ false > `optional` **validation?**: `boolean` -Defined in: [defaults.ts:93](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/defaults.ts#L93) +Defined in: [defaults.ts:93](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/defaults.ts#L93) Validation interceptor. Validates request messages using @connectrpc/validate. diff --git a/en/api/@connectum/interceptors/errorHandler/functions/createErrorHandlerInterceptor.md b/en/api/@connectum/interceptors/errorHandler/functions/createErrorHandlerInterceptor.md index df173668..751b215f 100644 --- a/en/api/@connectum/interceptors/errorHandler/functions/createErrorHandlerInterceptor.md +++ b/en/api/@connectum/interceptors/errorHandler/functions/createErrorHandlerInterceptor.md @@ -4,7 +4,7 @@ > **createErrorHandlerInterceptor**(`options?`): `Interceptor` -Defined in: [errorHandler.ts:48](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/errorHandler.ts#L48) +Defined in: [errorHandler.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/errorHandler.ts#L48) Create error handler interceptor diff --git a/en/api/@connectum/interceptors/fallback/functions/createFallbackInterceptor.md b/en/api/@connectum/interceptors/fallback/functions/createFallbackInterceptor.md index 247b660b..577d3fc3 100644 --- a/en/api/@connectum/interceptors/fallback/functions/createFallbackInterceptor.md +++ b/en/api/@connectum/interceptors/fallback/functions/createFallbackInterceptor.md @@ -4,7 +4,7 @@ > **createFallbackInterceptor**\<`T`\>(`options`): `Interceptor` -Defined in: [fallback.ts:57](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/fallback.ts#L57) +Defined in: [fallback.ts:57](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/fallback.ts#L57) Create fallback interceptor diff --git a/en/api/@connectum/interceptors/interfaces/BulkheadOptions.md b/en/api/@connectum/interceptors/interfaces/BulkheadOptions.md index 6dfa776d..7823a03e 100644 --- a/en/api/@connectum/interceptors/interfaces/BulkheadOptions.md +++ b/en/api/@connectum/interceptors/interfaces/BulkheadOptions.md @@ -2,7 +2,7 @@ # Interface: BulkheadOptions -Defined in: [types.ts:196](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L196) +Defined in: [types.ts:196](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L196) Bulkhead interceptor options @@ -12,7 +12,7 @@ Bulkhead interceptor options > `optional` **capacity?**: `number` -Defined in: [types.ts:201](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L201) +Defined in: [types.ts:201](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L201) Maximum number of concurrent requests @@ -28,7 +28,7 @@ Maximum number of concurrent requests > `optional` **queueSize?**: `number` -Defined in: [types.ts:207](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L207) +Defined in: [types.ts:207](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L207) Maximum queue size for pending requests @@ -44,7 +44,7 @@ Maximum queue size for pending requests > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:213](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L213) +Defined in: [types.ts:213](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L213) Skip bulkhead for streaming calls diff --git a/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md b/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md index 5d7cde2a..05a67706 100644 --- a/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md +++ b/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md @@ -2,7 +2,7 @@ # Interface: CircuitBreakerOptions -Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L126) +Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L126) Circuit breaker interceptor options @@ -12,7 +12,7 @@ Circuit breaker interceptor options > `optional` **failurePredicate?**: (`error`, `defaultPredicate`) => `boolean` -Defined in: [types.ts:173](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L173) +Defined in: [types.ts:173](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L173) Decides whether an error counts as a circuit failure. @@ -65,7 +65,7 @@ non-ConnectError values count as failures) > `optional` **halfOpenAfter?**: `number` -Defined in: [types.ts:137](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L137) +Defined in: [types.ts:137](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L137) Time in milliseconds to wait before attempting to close circuit @@ -81,7 +81,7 @@ Time in milliseconds to wait before attempting to close circuit > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:143](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L143) +Defined in: [types.ts:143](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L143) Skip circuit breaker for streaming calls @@ -97,7 +97,7 @@ true > `optional` **threshold?**: `number` -Defined in: [types.ts:131](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L131) +Defined in: [types.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L131) Number of consecutive failures before opening circuit diff --git a/en/api/@connectum/interceptors/interfaces/ErrorHandlerOptions.md b/en/api/@connectum/interceptors/interfaces/ErrorHandlerOptions.md index ef2a8090..8271e0cb 100644 --- a/en/api/@connectum/interceptors/interfaces/ErrorHandlerOptions.md +++ b/en/api/@connectum/interceptors/interfaces/ErrorHandlerOptions.md @@ -2,7 +2,7 @@ # Interface: ErrorHandlerOptions -Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L21) Error handler interceptor options @@ -12,7 +12,7 @@ Error handler interceptor options > `optional` **includeStackTrace?**: `boolean` -Defined in: [types.ts:33](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L33) +Defined in: [types.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L33) Include stack trace in logs @@ -28,7 +28,7 @@ process.env.NODE_ENV !== "production" > `optional` **logErrors?**: `boolean` -Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L27) Log errors to console. @@ -48,7 +48,7 @@ Use onError callback instead > `optional` **onError?**: (`info`) => `void` -Defined in: [types.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L39) +Defined in: [types.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L39) Callback for error logging. Replaces console.error when provided. Receives rich error info including serverDetails from SanitizableError. diff --git a/en/api/@connectum/interceptors/interfaces/FallbackOptions.md b/en/api/@connectum/interceptors/interfaces/FallbackOptions.md index 60c6405a..b1271922 100644 --- a/en/api/@connectum/interceptors/interfaces/FallbackOptions.md +++ b/en/api/@connectum/interceptors/interfaces/FallbackOptions.md @@ -2,7 +2,7 @@ # Interface: FallbackOptions\ -Defined in: [types.ts:219](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L219) +Defined in: [types.ts:219](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L219) Fallback interceptor options @@ -18,7 +18,7 @@ Fallback interceptor options > **handler**: (`error`) => `T` \| `Promise`\<`T`\> -Defined in: [types.ts:223](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L223) +Defined in: [types.ts:223](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L223) Fallback function to call on error @@ -38,7 +38,7 @@ Fallback function to call on error > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:229](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L229) +Defined in: [types.ts:229](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L229) Skip fallback for streaming calls diff --git a/en/api/@connectum/interceptors/interfaces/LoggerOptions.md b/en/api/@connectum/interceptors/interfaces/LoggerOptions.md index d53e0634..60b02d27 100644 --- a/en/api/@connectum/interceptors/interfaces/LoggerOptions.md +++ b/en/api/@connectum/interceptors/interfaces/LoggerOptions.md @@ -2,7 +2,7 @@ # Interface: LoggerOptions -Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L45) +Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L45) Logger interceptor options @@ -12,7 +12,7 @@ Logger interceptor options > `optional` **level?**: `"error"` \| `"warn"` \| `"debug"` \| `"info"` -Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L50) Log level @@ -28,7 +28,7 @@ Log level > `optional` **logger?**: (`message`, ...`args`) => `void` -Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L62) Custom logger function @@ -58,7 +58,7 @@ console[level] > `optional` **skipHealthCheck?**: `boolean` -Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L56) Skip logging for health check services diff --git a/en/api/@connectum/interceptors/interfaces/RetryOptions.md b/en/api/@connectum/interceptors/interfaces/RetryOptions.md index cb241c6f..8bf3d2f2 100644 --- a/en/api/@connectum/interceptors/interfaces/RetryOptions.md +++ b/en/api/@connectum/interceptors/interfaces/RetryOptions.md @@ -2,7 +2,7 @@ # Interface: RetryOptions -Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L91) +Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L91) Retry interceptor options @@ -12,7 +12,7 @@ Retry interceptor options > `optional` **initialDelay?**: `number` -Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L102) +Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L102) Initial delay in milliseconds for exponential backoff @@ -28,7 +28,7 @@ Initial delay in milliseconds for exponential backoff > `optional` **maxDelay?**: `number` -Defined in: [types.ts:108](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L108) +Defined in: [types.ts:108](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L108) Maximum delay in milliseconds for exponential backoff @@ -44,7 +44,7 @@ Maximum delay in milliseconds for exponential backoff > `optional` **maxRetries?**: `number` -Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L96) Maximum number of retries @@ -60,7 +60,7 @@ Maximum number of retries > `optional` **retryableCodes?**: `Code`[] -Defined in: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L120) +Defined in: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L120) Error codes that trigger a retry @@ -76,7 +76,7 @@ Error codes that trigger a retry > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L114) +Defined in: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L114) Skip retry for streaming requests diff --git a/en/api/@connectum/interceptors/interfaces/SerializerOptions.md b/en/api/@connectum/interceptors/interfaces/SerializerOptions.md index 83a8d874..6a10a4b7 100644 --- a/en/api/@connectum/interceptors/interfaces/SerializerOptions.md +++ b/en/api/@connectum/interceptors/interfaces/SerializerOptions.md @@ -2,7 +2,7 @@ # Interface: SerializerOptions -Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L68) +Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L68) Serializer interceptor options @@ -12,7 +12,7 @@ Serializer interceptor options > `optional` **alwaysEmitImplicit?**: `boolean` -Defined in: [types.ts:79](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L79) +Defined in: [types.ts:79](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L79) Always emit implicit fields in JSON @@ -28,7 +28,7 @@ true > `optional` **ignoreUnknownFields?**: `boolean` -Defined in: [types.ts:85](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L85) +Defined in: [types.ts:85](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L85) Ignore unknown fields when deserializing @@ -44,7 +44,7 @@ true > `optional` **skipGrpcServices?**: `boolean` -Defined in: [types.ts:73](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L73) +Defined in: [types.ts:73](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L73) Skip serialization for gRPC services diff --git a/en/api/@connectum/interceptors/interfaces/TimeoutOptions.md b/en/api/@connectum/interceptors/interfaces/TimeoutOptions.md index 938389b2..2134bc1c 100644 --- a/en/api/@connectum/interceptors/interfaces/TimeoutOptions.md +++ b/en/api/@connectum/interceptors/interfaces/TimeoutOptions.md @@ -2,7 +2,7 @@ # Interface: TimeoutOptions -Defined in: [types.ts:179](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L179) +Defined in: [types.ts:179](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L179) Timeout interceptor options @@ -12,7 +12,7 @@ Timeout interceptor options > `optional` **duration?**: `number` -Defined in: [types.ts:184](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L184) +Defined in: [types.ts:184](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L184) Request timeout in milliseconds @@ -28,7 +28,7 @@ Request timeout in milliseconds > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:190](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L190) +Defined in: [types.ts:190](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L190) Skip timeout for streaming calls diff --git a/en/api/@connectum/interceptors/logger/functions/createLoggerInterceptor.md b/en/api/@connectum/interceptors/logger/functions/createLoggerInterceptor.md index 96217d92..4d9b8a6b 100644 --- a/en/api/@connectum/interceptors/logger/functions/createLoggerInterceptor.md +++ b/en/api/@connectum/interceptors/logger/functions/createLoggerInterceptor.md @@ -4,7 +4,7 @@ > **createLoggerInterceptor**(`options?`): `Interceptor` -Defined in: [logger.ts:86](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/logger.ts#L86) +Defined in: [logger.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/logger.ts#L86) Create logger interceptor diff --git a/en/api/@connectum/interceptors/method-filter/functions/createMethodFilterInterceptor.md b/en/api/@connectum/interceptors/method-filter/functions/createMethodFilterInterceptor.md index eb47bfb9..04ec6bde 100644 --- a/en/api/@connectum/interceptors/method-filter/functions/createMethodFilterInterceptor.md +++ b/en/api/@connectum/interceptors/method-filter/functions/createMethodFilterInterceptor.md @@ -4,7 +4,7 @@ > **createMethodFilterInterceptor**(`methods`): `Interceptor` -Defined in: [method-filter.ts:130](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/method-filter.ts#L130) +Defined in: [method-filter.ts:130](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/method-filter.ts#L130) Create a method filter interceptor that routes to per-method interceptors based on wildcard pattern matching. diff --git a/en/api/@connectum/interceptors/retry/functions/createRetryInterceptor.md b/en/api/@connectum/interceptors/retry/functions/createRetryInterceptor.md index 729c455a..2cc8cbd8 100644 --- a/en/api/@connectum/interceptors/retry/functions/createRetryInterceptor.md +++ b/en/api/@connectum/interceptors/retry/functions/createRetryInterceptor.md @@ -4,7 +4,7 @@ > **createRetryInterceptor**(`options?`): `Interceptor` -Defined in: [retry.ts:44](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/retry.ts#L44) +Defined in: [retry.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/retry.ts#L44) Create retry interceptor diff --git a/en/api/@connectum/interceptors/serializer/functions/createSerializerInterceptor.md b/en/api/@connectum/interceptors/serializer/functions/createSerializerInterceptor.md index 5ee2f04c..91cc411d 100644 --- a/en/api/@connectum/interceptors/serializer/functions/createSerializerInterceptor.md +++ b/en/api/@connectum/interceptors/serializer/functions/createSerializerInterceptor.md @@ -4,7 +4,7 @@ > **createSerializerInterceptor**(`options?`): `Interceptor` -Defined in: [serializer.ts:84](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/serializer.ts#L84) +Defined in: [serializer.ts:84](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/serializer.ts#L84) Create serializer interceptor diff --git a/en/api/@connectum/interceptors/timeout/functions/createTimeoutInterceptor.md b/en/api/@connectum/interceptors/timeout/functions/createTimeoutInterceptor.md index abc809a3..decae9b7 100644 --- a/en/api/@connectum/interceptors/timeout/functions/createTimeoutInterceptor.md +++ b/en/api/@connectum/interceptors/timeout/functions/createTimeoutInterceptor.md @@ -4,7 +4,7 @@ > **createTimeoutInterceptor**(`options?`): `Interceptor` -Defined in: [timeout.ts:55](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/timeout.ts#L55) +Defined in: [timeout.ts:55](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/timeout.ts#L55) Create timeout interceptor diff --git a/en/api/@connectum/interceptors/type-aliases/InterceptorFactory.md b/en/api/@connectum/interceptors/type-aliases/InterceptorFactory.md index a28d4ad4..335ae143 100644 --- a/en/api/@connectum/interceptors/type-aliases/InterceptorFactory.md +++ b/en/api/@connectum/interceptors/type-aliases/InterceptorFactory.md @@ -4,7 +4,7 @@ > **InterceptorFactory**\<`TOptions`\> = `TOptions` *extends* `void` ? () => `Interceptor` : (`options`) => `Interceptor` -Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L16) Interceptor factory function type diff --git a/en/api/@connectum/interceptors/type-aliases/MethodFilterMap.md b/en/api/@connectum/interceptors/type-aliases/MethodFilterMap.md index 3d6f6e25..bcf869e2 100644 --- a/en/api/@connectum/interceptors/type-aliases/MethodFilterMap.md +++ b/en/api/@connectum/interceptors/type-aliases/MethodFilterMap.md @@ -4,7 +4,7 @@ > **MethodFilterMap** = `Record`\<`string`, `Interceptor`[]\> -Defined in: [types.ts:254](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/interceptors/src/types.ts#L254) +Defined in: [types.ts:254](https://github.com/Connectum-Framework/connectum/blob/main/packages/interceptors/src/types.ts#L254) Method pattern to interceptors mapping. diff --git a/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md b/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md index 4f550010..26c6c58f 100644 --- a/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md +++ b/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md @@ -4,7 +4,7 @@ > **ConnectErrorCode** = *typeof* [`ConnectErrorCode`](../variables/ConnectErrorCode.md)\[keyof *typeof* [`ConnectErrorCode`](../variables/ConnectErrorCode.md)\] -Defined in: [packages/otel/src/attributes.ts:66](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L66) +Defined in: [packages/otel/src/attributes.ts:66](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L66) ConnectRPC error code map (numeric code -> string name) Based on Connect protocol error codes diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md b/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md index 4b06bf51..336b3947 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md @@ -4,7 +4,7 @@ > `const` **ATTR\_CONNECTUM\_TRANSPORT**: `"connectum.transport"` = `"connectum.transport"` -Defined in: [packages/otel/src/attributes.ts:43](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L43) +Defined in: [packages/otel/src/attributes.ts:43](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L43) Connectum-specific span attribute that distinguishes RPC observations carried by the in-process router transport from those carried by HTTP/2. diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md b/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md index 4a5f7a74..33d89613 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md @@ -4,7 +4,7 @@ > `const` **ATTR\_CONNECTUM\_TRANSPORT\_METRIC**: `"transport"` = `"transport"` -Defined in: [packages/otel/src/attributes.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L50) +Defined in: [packages/otel/src/attributes.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L50) Metric-label counterpart of [ATTR\_CONNECTUM\_TRANSPORT](ATTR_CONNECTUM_TRANSPORT.md). diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_ERROR_TYPE.md b/en/api/@connectum/otel/attributes/variables/ATTR_ERROR_TYPE.md index e1d0c6e2..ffc5af03 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_ERROR_TYPE.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_ERROR_TYPE.md @@ -4,4 +4,4 @@ > `const` **ATTR\_ERROR\_TYPE**: `"error.type"` = `"error.type"` -Defined in: [packages/otel/src/attributes.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L20) +Defined in: [packages/otel/src/attributes.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L20) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_ADDRESS.md b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_ADDRESS.md index f01fca6d..7db95375 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_ADDRESS.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_ADDRESS.md @@ -4,4 +4,4 @@ > `const` **ATTR\_NETWORK\_PEER\_ADDRESS**: `"network.peer.address"` = `"network.peer.address"` -Defined in: [packages/otel/src/attributes.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L25) +Defined in: [packages/otel/src/attributes.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L25) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_PORT.md b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_PORT.md index 6cb273a0..b7b015c9 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_PORT.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_PORT.md @@ -4,4 +4,4 @@ > `const` **ATTR\_NETWORK\_PEER\_PORT**: `"network.peer.port"` = `"network.peer.port"` -Defined in: [packages/otel/src/attributes.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L26) +Defined in: [packages/otel/src/attributes.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L26) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PROTOCOL_NAME.md b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PROTOCOL_NAME.md index a6202ad8..321b7d6b 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PROTOCOL_NAME.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PROTOCOL_NAME.md @@ -4,4 +4,4 @@ > `const` **ATTR\_NETWORK\_PROTOCOL\_NAME**: `"network.protocol.name"` = `"network.protocol.name"` -Defined in: [packages/otel/src/attributes.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L23) +Defined in: [packages/otel/src/attributes.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L23) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_TRANSPORT.md b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_TRANSPORT.md index ae695996..ce3cc364 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_TRANSPORT.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_TRANSPORT.md @@ -4,4 +4,4 @@ > `const` **ATTR\_NETWORK\_TRANSPORT**: `"network.transport"` = `"network.transport"` -Defined in: [packages/otel/src/attributes.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L24) +Defined in: [packages/otel/src/attributes.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L24) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_CONNECT_RPC_STATUS_CODE.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_CONNECT_RPC_STATUS_CODE.md index 24c717be..c2e3c779 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_CONNECT_RPC_STATUS_CODE.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_CONNECT_RPC_STATUS_CODE.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_CONNECT\_RPC\_STATUS\_CODE**: `"rpc.connect_rpc.status_code"` = `"rpc.connect_rpc.status_code"` -Defined in: [packages/otel/src/attributes.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L19) +Defined in: [packages/otel/src/attributes.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L19) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_ID.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_ID.md index cd1313ec..28a49eac 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_ID.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_ID.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_MESSAGE\_ID**: `"rpc.message.id"` = `"rpc.message.id"` -Defined in: [packages/otel/src/attributes.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L59) +Defined in: [packages/otel/src/attributes.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L59) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_TYPE.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_TYPE.md index c10c6c4b..f88ae029 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_TYPE.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_TYPE.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_MESSAGE\_TYPE**: `"rpc.message.type"` = `"rpc.message.type"` -Defined in: [packages/otel/src/attributes.ts:58](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L58) +Defined in: [packages/otel/src/attributes.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L58) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md index 729ee2e1..50943a55 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_MESSAGE\_UNCOMPRESSED\_SIZE**: `"rpc.message.uncompressed_size"` = `"rpc.message.uncompressed_size"` -Defined in: [packages/otel/src/attributes.ts:60](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L60) +Defined in: [packages/otel/src/attributes.ts:60](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L60) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_METHOD.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_METHOD.md index f7935953..82ceb991 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_METHOD.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_METHOD.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_METHOD**: `"rpc.method"` = `"rpc.method"` -Defined in: [packages/otel/src/attributes.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L18) +Defined in: [packages/otel/src/attributes.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L18) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SERVICE.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SERVICE.md index 0fb2ce20..6678768a 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SERVICE.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SERVICE.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_SERVICE**: `"rpc.service"` = `"rpc.service"` -Defined in: [packages/otel/src/attributes.ts:17](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L17) +Defined in: [packages/otel/src/attributes.ts:17](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L17) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SYSTEM.md b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SYSTEM.md index c5dd8997..850738f6 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SYSTEM.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SYSTEM.md @@ -4,4 +4,4 @@ > `const` **ATTR\_RPC\_SYSTEM**: `"rpc.system"` = `"rpc.system"` -Defined in: [packages/otel/src/attributes.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L16) +Defined in: [packages/otel/src/attributes.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L16) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_ADDRESS.md b/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_ADDRESS.md index d3f6510c..3b37cee8 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_ADDRESS.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_ADDRESS.md @@ -4,4 +4,4 @@ > `const` **ATTR\_SERVER\_ADDRESS**: `"server.address"` = `"server.address"` -Defined in: [packages/otel/src/attributes.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L21) +Defined in: [packages/otel/src/attributes.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L21) diff --git a/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_PORT.md b/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_PORT.md index 7b7b3d8b..e5d39646 100644 --- a/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_PORT.md +++ b/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_PORT.md @@ -4,4 +4,4 @@ > `const` **ATTR\_SERVER\_PORT**: `"server.port"` = `"server.port"` -Defined in: [packages/otel/src/attributes.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L22) +Defined in: [packages/otel/src/attributes.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L22) diff --git a/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md b/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md index 9facf7d7..286907cc 100644 --- a/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md +++ b/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md @@ -4,6 +4,6 @@ > `const` **CONNECTUM\_INTERNAL\_TRANSPORT\_HEADER**: `"connectum-internal-transport"` = `"connectum-internal-transport"` -Defined in: [packages/otel/src/attributes.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L52) +Defined in: [packages/otel/src/attributes.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L52) Marker request header set by `createLocalTransport` from `@connectum/core`. diff --git a/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md b/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md index 06e44e73..fbc0931c 100644 --- a/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md +++ b/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md @@ -4,6 +4,6 @@ > `const` **CONNECTUM\_INTERNAL\_TRANSPORT\_IN\_PROCESS**: `"in-process"` = `"in-process"` -Defined in: [packages/otel/src/attributes.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L54) +Defined in: [packages/otel/src/attributes.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L54) Header value indicating an in-process call (the only one currently defined). diff --git a/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md b/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md index 4c7aa8c3..4d4f03a7 100644 --- a/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md +++ b/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md @@ -4,7 +4,7 @@ > `const` **ConnectErrorCode**: `object` -Defined in: [packages/otel/src/attributes.ts:66](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L66) +Defined in: [packages/otel/src/attributes.ts:66](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L66) ConnectRPC error code map (numeric code -> string name) Based on Connect protocol error codes diff --git a/en/api/@connectum/otel/attributes/variables/ConnectErrorCodeName.md b/en/api/@connectum/otel/attributes/variables/ConnectErrorCodeName.md index a5fa867f..155ccee0 100644 --- a/en/api/@connectum/otel/attributes/variables/ConnectErrorCodeName.md +++ b/en/api/@connectum/otel/attributes/variables/ConnectErrorCodeName.md @@ -4,6 +4,6 @@ > `const` **ConnectErrorCodeName**: `Record`\<`number`, `string`\> -Defined in: [packages/otel/src/attributes.ts:90](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L90) +Defined in: [packages/otel/src/attributes.ts:90](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L90) Reverse map: numeric code -> string name for span attributes diff --git a/en/api/@connectum/otel/attributes/variables/RPC_MESSAGE_EVENT.md b/en/api/@connectum/otel/attributes/variables/RPC_MESSAGE_EVENT.md index 8ebc9b6e..46a28709 100644 --- a/en/api/@connectum/otel/attributes/variables/RPC_MESSAGE_EVENT.md +++ b/en/api/@connectum/otel/attributes/variables/RPC_MESSAGE_EVENT.md @@ -4,4 +4,4 @@ > `const` **RPC\_MESSAGE\_EVENT**: `"rpc.message"` = `"rpc.message"` -Defined in: [packages/otel/src/attributes.ts:57](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L57) +Defined in: [packages/otel/src/attributes.ts:57](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L57) diff --git a/en/api/@connectum/otel/attributes/variables/RPC_SYSTEM_CONNECT_RPC.md b/en/api/@connectum/otel/attributes/variables/RPC_SYSTEM_CONNECT_RPC.md index 510b26d2..07def754 100644 --- a/en/api/@connectum/otel/attributes/variables/RPC_SYSTEM_CONNECT_RPC.md +++ b/en/api/@connectum/otel/attributes/variables/RPC_SYSTEM_CONNECT_RPC.md @@ -4,4 +4,4 @@ > `const` **RPC\_SYSTEM\_CONNECT\_RPC**: `"connect_rpc"` = `"connect_rpc"` -Defined in: [packages/otel/src/attributes.ts:13](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/attributes.ts#L13) +Defined in: [packages/otel/src/attributes.ts:13](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/attributes.ts#L13) diff --git a/en/api/@connectum/otel/client-interceptor/functions/createOtelClientInterceptor.md b/en/api/@connectum/otel/client-interceptor/functions/createOtelClientInterceptor.md index be54e646..58d7292a 100644 --- a/en/api/@connectum/otel/client-interceptor/functions/createOtelClientInterceptor.md +++ b/en/api/@connectum/otel/client-interceptor/functions/createOtelClientInterceptor.md @@ -4,7 +4,7 @@ > **createOtelClientInterceptor**(`options`): `Interceptor` -Defined in: [packages/otel/src/client-interceptor.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/client-interceptor.ts#L59) +Defined in: [packages/otel/src/client-interceptor.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/client-interceptor.ts#L59) Creates a ConnectRPC interceptor that instruments outgoing RPC calls with OpenTelemetry tracing and/or metrics. diff --git a/en/api/@connectum/otel/functions/getBatchSpanProcessorOptions.md b/en/api/@connectum/otel/functions/getBatchSpanProcessorOptions.md index 163c6ff0..d1b01906 100644 --- a/en/api/@connectum/otel/functions/getBatchSpanProcessorOptions.md +++ b/en/api/@connectum/otel/functions/getBatchSpanProcessorOptions.md @@ -4,7 +4,7 @@ > **getBatchSpanProcessorOptions**(): [`BatchSpanProcessorOptions`](../interfaces/BatchSpanProcessorOptions.md) -Defined in: [packages/otel/src/config.ts:100](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L100) +Defined in: [packages/otel/src/config.ts:100](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L100) Gets batch span processor options from environment variables diff --git a/en/api/@connectum/otel/functions/getCollectorOptions.md b/en/api/@connectum/otel/functions/getCollectorOptions.md index 7162c0a4..0844d11d 100644 --- a/en/api/@connectum/otel/functions/getCollectorOptions.md +++ b/en/api/@connectum/otel/functions/getCollectorOptions.md @@ -4,7 +4,7 @@ > **getCollectorOptions**(): [`CollectorOptions`](../interfaces/CollectorOptions.md) -Defined in: [packages/otel/src/config.ts:81](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L81) +Defined in: [packages/otel/src/config.ts:81](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L81) Gets collector endpoint options from environment variables diff --git a/en/api/@connectum/otel/functions/getOTLPSettings.md b/en/api/@connectum/otel/functions/getOTLPSettings.md index e4f48eb5..76f45e01 100644 --- a/en/api/@connectum/otel/functions/getOTLPSettings.md +++ b/en/api/@connectum/otel/functions/getOTLPSettings.md @@ -4,7 +4,7 @@ > **getOTLPSettings**(): [`OTLPSettings`](../interfaces/OTLPSettings.md) -Defined in: [packages/otel/src/config.ts:65](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L65) +Defined in: [packages/otel/src/config.ts:65](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L65) Gets OTLP exporter settings from environment variables diff --git a/en/api/@connectum/otel/functions/getServiceMetadata.md b/en/api/@connectum/otel/functions/getServiceMetadata.md index 58cff926..617c5a3d 100644 --- a/en/api/@connectum/otel/functions/getServiceMetadata.md +++ b/en/api/@connectum/otel/functions/getServiceMetadata.md @@ -4,7 +4,7 @@ > **getServiceMetadata**(): `object` -Defined in: [packages/otel/src/config.ts:116](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L116) +Defined in: [packages/otel/src/config.ts:116](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L116) Gets service metadata from environment variables diff --git a/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md b/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md index 77fbf9e8..458453eb 100644 --- a/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md +++ b/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md @@ -4,7 +4,7 @@ > **createOtelInterceptor**(`options?`): `Interceptor` -Defined in: [packages/otel/src/interceptor.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/interceptor.ts#L52) +Defined in: [packages/otel/src/interceptor.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/interceptor.ts#L52) Creates a ConnectRPC interceptor that instruments RPC calls with OpenTelemetry tracing and/or metrics. diff --git a/en/api/@connectum/otel/interfaces/BatchSpanProcessorOptions.md b/en/api/@connectum/otel/interfaces/BatchSpanProcessorOptions.md index 3ad41ebc..a26857f1 100644 --- a/en/api/@connectum/otel/interfaces/BatchSpanProcessorOptions.md +++ b/en/api/@connectum/otel/interfaces/BatchSpanProcessorOptions.md @@ -2,7 +2,7 @@ # Interface: BatchSpanProcessorOptions -Defined in: [packages/otel/src/config.ts:48](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L48) +Defined in: [packages/otel/src/config.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L48) Batch span processor options @@ -12,7 +12,7 @@ Batch span processor options > **exportTimeoutMillis**: `number` -Defined in: [packages/otel/src/config.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L52) +Defined in: [packages/otel/src/config.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L52) *** @@ -20,7 +20,7 @@ Defined in: [packages/otel/src/config.ts:52](https://github.com/Connectum-Framew > **maxExportBatchSize**: `number` -Defined in: [packages/otel/src/config.ts:49](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L49) +Defined in: [packages/otel/src/config.ts:49](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L49) *** @@ -28,7 +28,7 @@ Defined in: [packages/otel/src/config.ts:49](https://github.com/Connectum-Framew > **maxQueueSize**: `number` -Defined in: [packages/otel/src/config.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L50) +Defined in: [packages/otel/src/config.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L50) *** @@ -36,4 +36,4 @@ Defined in: [packages/otel/src/config.ts:50](https://github.com/Connectum-Framew > **scheduledDelayMillis**: `number` -Defined in: [packages/otel/src/config.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L51) +Defined in: [packages/otel/src/config.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L51) diff --git a/en/api/@connectum/otel/interfaces/CollectorOptions.md b/en/api/@connectum/otel/interfaces/CollectorOptions.md index d3524de7..04ec6542 100644 --- a/en/api/@connectum/otel/interfaces/CollectorOptions.md +++ b/en/api/@connectum/otel/interfaces/CollectorOptions.md @@ -2,7 +2,7 @@ # Interface: CollectorOptions -Defined in: [packages/otel/src/config.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L40) +Defined in: [packages/otel/src/config.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L40) Collector endpoint options @@ -12,7 +12,7 @@ Collector endpoint options > **concurrencyLimit**: `number` -Defined in: [packages/otel/src/config.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L41) +Defined in: [packages/otel/src/config.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L41) *** @@ -20,4 +20,4 @@ Defined in: [packages/otel/src/config.ts:41](https://github.com/Connectum-Framew > **url**: `string` \| `undefined` -Defined in: [packages/otel/src/config.ts:42](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L42) +Defined in: [packages/otel/src/config.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L42) diff --git a/en/api/@connectum/otel/interfaces/OTLPSettings.md b/en/api/@connectum/otel/interfaces/OTLPSettings.md index 962e8200..6dbe8cd0 100644 --- a/en/api/@connectum/otel/interfaces/OTLPSettings.md +++ b/en/api/@connectum/otel/interfaces/OTLPSettings.md @@ -2,7 +2,7 @@ # Interface: OTLPSettings -Defined in: [packages/otel/src/config.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L31) +Defined in: [packages/otel/src/config.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L31) OTLP settings for traces, metrics, and logs @@ -12,7 +12,7 @@ OTLP settings for traces, metrics, and logs > **logs**: [`ExporterType`](../type-aliases/ExporterType.md) -Defined in: [packages/otel/src/config.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L34) +Defined in: [packages/otel/src/config.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L34) *** @@ -20,7 +20,7 @@ Defined in: [packages/otel/src/config.ts:34](https://github.com/Connectum-Framew > **metrics**: [`ExporterType`](../type-aliases/ExporterType.md) -Defined in: [packages/otel/src/config.ts:33](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L33) +Defined in: [packages/otel/src/config.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L33) *** @@ -28,4 +28,4 @@ Defined in: [packages/otel/src/config.ts:33](https://github.com/Connectum-Framew > **traces**: [`ExporterType`](../type-aliases/ExporterType.md) -Defined in: [packages/otel/src/config.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L32) +Defined in: [packages/otel/src/config.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L32) diff --git a/en/api/@connectum/otel/interfaces/OtelBaseOptions.md b/en/api/@connectum/otel/interfaces/OtelBaseOptions.md index 2fa612e4..050cd9fe 100644 --- a/en/api/@connectum/otel/interfaces/OtelBaseOptions.md +++ b/en/api/@connectum/otel/interfaces/OtelBaseOptions.md @@ -2,7 +2,7 @@ # Interface: OtelBaseOptions -Defined in: [packages/otel/src/types.ts:29](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L29) +Defined in: [packages/otel/src/types.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L29) Common options shared between server and client OTel interceptors @@ -17,7 +17,7 @@ Common options shared between server and client OTel interceptors > `optional` **attributeFilter?**: [`OtelAttributeFilter`](../type-aliases/OtelAttributeFilter.md) -Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L40) Filter callback to exclude specific attributes @@ -27,7 +27,7 @@ Filter callback to exclude specific attributes > `optional` **filter?**: [`OtelFilter`](../type-aliases/OtelFilter.md) -Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L37) Filter callback to skip specific requests @@ -37,7 +37,7 @@ Filter callback to skip specific requests > `optional` **recordMessages?**: `boolean` -Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L47) Include request/response message content in span events. WARNING: May contain sensitive data. @@ -54,7 +54,7 @@ false > `optional` **withoutMetrics?**: `boolean` -Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L34) Disable metric recording (tracing only) @@ -64,6 +64,6 @@ Disable metric recording (tracing only) > `optional` **withoutTracing?**: `boolean` -Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L31) Disable span creation (metrics only) diff --git a/en/api/@connectum/otel/interfaces/OtelClientInterceptorOptions.md b/en/api/@connectum/otel/interfaces/OtelClientInterceptorOptions.md index 65d1bd92..8f038e1a 100644 --- a/en/api/@connectum/otel/interfaces/OtelClientInterceptorOptions.md +++ b/en/api/@connectum/otel/interfaces/OtelClientInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: OtelClientInterceptorOptions -Defined in: [packages/otel/src/types.ts:75](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L75) +Defined in: [packages/otel/src/types.ts:75](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L75) Options for createOtelClientInterceptor() (client-side) @@ -16,7 +16,7 @@ Options for createOtelClientInterceptor() (client-side) > `optional` **attributeFilter?**: [`OtelAttributeFilter`](../type-aliases/OtelAttributeFilter.md) -Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L40) Filter callback to exclude specific attributes @@ -30,7 +30,7 @@ Filter callback to exclude specific attributes > `optional` **filter?**: [`OtelFilter`](../type-aliases/OtelFilter.md) -Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L37) Filter callback to skip specific requests @@ -44,7 +44,7 @@ Filter callback to skip specific requests > `optional` **recordMessages?**: `boolean` -Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L47) Include request/response message content in span events. WARNING: May contain sensitive data. @@ -65,7 +65,7 @@ false > **serverAddress**: `string` -Defined in: [packages/otel/src/types.ts:80](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L80) +Defined in: [packages/otel/src/types.ts:80](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L80) Target server address (required for client spans). Used as `server.address` attribute. @@ -76,7 +76,7 @@ Used as `server.address` attribute. > `optional` **serverPort?**: `number` -Defined in: [packages/otel/src/types.ts:86](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L86) +Defined in: [packages/otel/src/types.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L86) Target server port. Used as `server.port` attribute. @@ -87,7 +87,7 @@ Used as `server.port` attribute. > `optional` **withoutMetrics?**: `boolean` -Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L34) Disable metric recording (tracing only) @@ -101,7 +101,7 @@ Disable metric recording (tracing only) > `optional` **withoutTracing?**: `boolean` -Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L31) Disable span creation (metrics only) diff --git a/en/api/@connectum/otel/interfaces/OtelInterceptorOptions.md b/en/api/@connectum/otel/interfaces/OtelInterceptorOptions.md index 690dc471..e5e4c9c1 100644 --- a/en/api/@connectum/otel/interfaces/OtelInterceptorOptions.md +++ b/en/api/@connectum/otel/interfaces/OtelInterceptorOptions.md @@ -2,7 +2,7 @@ # Interface: OtelInterceptorOptions -Defined in: [packages/otel/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L53) +Defined in: [packages/otel/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L53) Options for createOtelInterceptor() (server-side) @@ -16,7 +16,7 @@ Options for createOtelInterceptor() (server-side) > `optional` **attributeFilter?**: [`OtelAttributeFilter`](../type-aliases/OtelAttributeFilter.md) -Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L40) Filter callback to exclude specific attributes @@ -30,7 +30,7 @@ Filter callback to exclude specific attributes > `optional` **filter?**: [`OtelFilter`](../type-aliases/OtelFilter.md) -Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L37) Filter callback to skip specific requests @@ -44,7 +44,7 @@ Filter callback to skip specific requests > `optional` **recordMessages?**: `boolean` -Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L47) Include request/response message content in span events. WARNING: May contain sensitive data. @@ -65,7 +65,7 @@ false > `optional` **serverAddress?**: `string` -Defined in: [packages/otel/src/types.ts:64](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L64) +Defined in: [packages/otel/src/types.ts:64](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L64) Override server.address attribute (defaults to os.hostname()) @@ -75,7 +75,7 @@ Override server.address attribute (defaults to os.hostname()) > `optional` **serverPort?**: `number` -Defined in: [packages/otel/src/types.ts:69](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L69) +Defined in: [packages/otel/src/types.ts:69](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L69) Opt-in server.port attribute @@ -85,7 +85,7 @@ Opt-in server.port attribute > `optional` **trustRemote?**: `boolean` -Defined in: [packages/otel/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L59) +Defined in: [packages/otel/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L59) Use extracted remote context as parent span. When false, creates a new root span and adds a link to the remote span. @@ -102,7 +102,7 @@ false > `optional` **withoutMetrics?**: `boolean` -Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L34) Disable metric recording (tracing only) @@ -116,7 +116,7 @@ Disable metric recording (tracing only) > `optional` **withoutTracing?**: `boolean` -Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L31) Disable span creation (metrics only) diff --git a/en/api/@connectum/otel/interfaces/TraceAllOptions.md b/en/api/@connectum/otel/interfaces/TraceAllOptions.md index 43b6d939..bc1a34b9 100644 --- a/en/api/@connectum/otel/interfaces/TraceAllOptions.md +++ b/en/api/@connectum/otel/interfaces/TraceAllOptions.md @@ -2,7 +2,7 @@ # Interface: TraceAllOptions -Defined in: [packages/otel/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L133) +Defined in: [packages/otel/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L133) Options for traceAll() Proxy-based object wrapper @@ -12,7 +12,7 @@ Options for traceAll() Proxy-based object wrapper > `optional` **argsFilter?**: [`MethodArgsFilter`](../type-aliases/MethodArgsFilter.md) -Defined in: [packages/otel/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L157) +Defined in: [packages/otel/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L157) Transform/masking for recorded args -- has access to method name. @@ -22,7 +22,7 @@ Transform/masking for recorded args -- has access to method name. > `optional` **exclude?**: `string`[] -Defined in: [packages/otel/src/types.ts:144](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L144) +Defined in: [packages/otel/src/types.ts:144](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L144) Blacklist of method names to exclude from wrapping @@ -32,7 +32,7 @@ Blacklist of method names to exclude from wrapping > `optional` **include?**: `string`[] -Defined in: [packages/otel/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L141) +Defined in: [packages/otel/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L141) Whitelist of method names to wrap (if provided, only these are wrapped) @@ -42,7 +42,7 @@ Whitelist of method names to wrap (if provided, only these are wrapped) > `optional` **prefix?**: `string` -Defined in: [packages/otel/src/types.ts:138](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L138) +Defined in: [packages/otel/src/types.ts:138](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L138) Prefix for span names: "${prefix}.${methodName}" Defaults to constructor.name or "Object" @@ -53,7 +53,7 @@ Defaults to constructor.name or "Object" > `optional` **recordArgs?**: `boolean` \| `string`[] -Defined in: [packages/otel/src/types.ts:152](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L152) +Defined in: [packages/otel/src/types.ts:152](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L152) Record method arguments as span attributes. - `false` (default): no args recorded diff --git a/en/api/@connectum/otel/interfaces/TracedOptions.md b/en/api/@connectum/otel/interfaces/TracedOptions.md index a5217cfe..041e165b 100644 --- a/en/api/@connectum/otel/interfaces/TracedOptions.md +++ b/en/api/@connectum/otel/interfaces/TracedOptions.md @@ -2,7 +2,7 @@ # Interface: TracedOptions -Defined in: [packages/otel/src/types.ts:104](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L104) +Defined in: [packages/otel/src/types.ts:104](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L104) Options for traced() function wrapper @@ -12,7 +12,7 @@ Options for traced() function wrapper > `optional` **argsFilter?**: [`ArgsFilter`](../type-aliases/ArgsFilter.md) -Defined in: [packages/otel/src/types.ts:122](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L122) +Defined in: [packages/otel/src/types.ts:122](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L122) Additional transform/masking for recorded args. Called after whitelist filtering. @@ -23,7 +23,7 @@ Called after whitelist filtering. > `optional` **attributes?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [packages/otel/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L127) +Defined in: [packages/otel/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L127) Custom attributes to add to every span @@ -33,7 +33,7 @@ Custom attributes to add to every span > `optional` **name?**: `string` -Defined in: [packages/otel/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L108) +Defined in: [packages/otel/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L108) Span name. Defaults to fn.name or "anonymous" @@ -43,7 +43,7 @@ Span name. Defaults to fn.name or "anonymous" > `optional` **recordArgs?**: `boolean` \| `string`[] -Defined in: [packages/otel/src/types.ts:116](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L116) +Defined in: [packages/otel/src/types.ts:116](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L116) Record function arguments as span attributes. - `false` (default): no args recorded diff --git a/en/api/@connectum/otel/logger/functions/getLogger.md b/en/api/@connectum/otel/logger/functions/getLogger.md index b415691a..df5c714b 100644 --- a/en/api/@connectum/otel/logger/functions/getLogger.md +++ b/en/api/@connectum/otel/logger/functions/getLogger.md @@ -4,7 +4,7 @@ > **getLogger**(`name?`, `options?`): [`Logger`](../interfaces/Logger.md) -Defined in: [packages/otel/src/logger.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L28) +Defined in: [packages/otel/src/logger.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L28) ## Parameters diff --git a/en/api/@connectum/otel/logger/interfaces/Logger.md b/en/api/@connectum/otel/logger/interfaces/Logger.md index 2b04721e..3011f961 100644 --- a/en/api/@connectum/otel/logger/interfaces/Logger.md +++ b/en/api/@connectum/otel/logger/interfaces/Logger.md @@ -2,7 +2,7 @@ # Interface: Logger -Defined in: [packages/otel/src/logger.ts:11](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L11) +Defined in: [packages/otel/src/logger.ts:11](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L11) ## Methods @@ -10,7 +10,7 @@ Defined in: [packages/otel/src/logger.ts:11](https://github.com/Connectum-Framew > **debug**(`message`, `attributes?`): `void` -Defined in: [packages/otel/src/logger.ts:15](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L15) +Defined in: [packages/otel/src/logger.ts:15](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L15) #### Parameters @@ -32,7 +32,7 @@ Defined in: [packages/otel/src/logger.ts:15](https://github.com/Connectum-Framew > **emit**(`record`): `void` -Defined in: [packages/otel/src/logger.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L16) +Defined in: [packages/otel/src/logger.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L16) #### Parameters @@ -50,7 +50,7 @@ Defined in: [packages/otel/src/logger.ts:16](https://github.com/Connectum-Framew > **error**(`message`, `attributes?`): `void` -Defined in: [packages/otel/src/logger.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L14) +Defined in: [packages/otel/src/logger.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L14) #### Parameters @@ -72,7 +72,7 @@ Defined in: [packages/otel/src/logger.ts:14](https://github.com/Connectum-Framew > **info**(`message`, `attributes?`): `void` -Defined in: [packages/otel/src/logger.ts:12](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L12) +Defined in: [packages/otel/src/logger.ts:12](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L12) #### Parameters @@ -94,7 +94,7 @@ Defined in: [packages/otel/src/logger.ts:12](https://github.com/Connectum-Framew > **warn**(`message`, `attributes?`): `void` -Defined in: [packages/otel/src/logger.ts:13](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L13) +Defined in: [packages/otel/src/logger.ts:13](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L13) #### Parameters diff --git a/en/api/@connectum/otel/logger/interfaces/LoggerOptions.md b/en/api/@connectum/otel/logger/interfaces/LoggerOptions.md index 33571f31..7e460e3a 100644 --- a/en/api/@connectum/otel/logger/interfaces/LoggerOptions.md +++ b/en/api/@connectum/otel/logger/interfaces/LoggerOptions.md @@ -2,7 +2,7 @@ # Interface: LoggerOptions -Defined in: [packages/otel/src/logger.ts:7](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L7) +Defined in: [packages/otel/src/logger.ts:7](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L7) ## Properties @@ -10,4 +10,4 @@ Defined in: [packages/otel/src/logger.ts:7](https://github.com/Connectum-Framewo > `optional` **defaultAttributes?**: `AnyValueMap` -Defined in: [packages/otel/src/logger.ts:8](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/logger.ts#L8) +Defined in: [packages/otel/src/logger.ts:8](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/logger.ts#L8) diff --git a/en/api/@connectum/otel/meter/functions/getMeter.md b/en/api/@connectum/otel/meter/functions/getMeter.md index 1d8ba84a..8cf9c6b9 100644 --- a/en/api/@connectum/otel/meter/functions/getMeter.md +++ b/en/api/@connectum/otel/meter/functions/getMeter.md @@ -4,7 +4,7 @@ > **getMeter**(): [`Meter`](../../interfaces/Meter.md) -Defined in: [packages/otel/src/meter.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/meter.ts#L14) +Defined in: [packages/otel/src/meter.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/meter.ts#L14) Returns the global Meter instance. Lazily initializes the OTel provider on first call. diff --git a/en/api/@connectum/otel/metrics/functions/createRpcClientMetrics.md b/en/api/@connectum/otel/metrics/functions/createRpcClientMetrics.md index e92a1cf7..22705ce1 100644 --- a/en/api/@connectum/otel/metrics/functions/createRpcClientMetrics.md +++ b/en/api/@connectum/otel/metrics/functions/createRpcClientMetrics.md @@ -4,7 +4,7 @@ > **createRpcClientMetrics**(`meter`): [`RpcClientMetrics`](../interfaces/RpcClientMetrics.md) -Defined in: [packages/otel/src/metrics.ts:106](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L106) +Defined in: [packages/otel/src/metrics.ts:106](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L106) Creates RPC client metric instruments from the given meter diff --git a/en/api/@connectum/otel/metrics/functions/createRpcServerMetrics.md b/en/api/@connectum/otel/metrics/functions/createRpcServerMetrics.md index fe963963..d19065c2 100644 --- a/en/api/@connectum/otel/metrics/functions/createRpcServerMetrics.md +++ b/en/api/@connectum/otel/metrics/functions/createRpcServerMetrics.md @@ -4,7 +4,7 @@ > **createRpcServerMetrics**(`meter`): [`RpcServerMetrics`](../interfaces/RpcServerMetrics.md) -Defined in: [packages/otel/src/metrics.ts:65](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L65) +Defined in: [packages/otel/src/metrics.ts:65](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L65) Creates RPC server metric instruments from the given meter diff --git a/en/api/@connectum/otel/metrics/interfaces/RpcClientMetrics.md b/en/api/@connectum/otel/metrics/interfaces/RpcClientMetrics.md index dd807421..ed85fc04 100644 --- a/en/api/@connectum/otel/metrics/interfaces/RpcClientMetrics.md +++ b/en/api/@connectum/otel/metrics/interfaces/RpcClientMetrics.md @@ -2,7 +2,7 @@ # Interface: RpcClientMetrics -Defined in: [packages/otel/src/metrics.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L34) +Defined in: [packages/otel/src/metrics.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L34) Pre-configured RPC client metric instruments @@ -15,7 +15,7 @@ following OpenTelemetry RPC semantic conventions. > **callDuration**: `Histogram` -Defined in: [packages/otel/src/metrics.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L36) +Defined in: [packages/otel/src/metrics.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L36) Histogram measuring duration of RPC client calls (unit: seconds) @@ -25,7 +25,7 @@ Histogram measuring duration of RPC client calls (unit: seconds) > **requestSize**: `Histogram` -Defined in: [packages/otel/src/metrics.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L38) +Defined in: [packages/otel/src/metrics.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L38) Histogram measuring size of RPC client request messages (unit: bytes) @@ -35,6 +35,6 @@ Histogram measuring size of RPC client request messages (unit: bytes) > **responseSize**: `Histogram` -Defined in: [packages/otel/src/metrics.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L40) +Defined in: [packages/otel/src/metrics.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L40) Histogram measuring size of RPC client response messages (unit: bytes) diff --git a/en/api/@connectum/otel/metrics/interfaces/RpcServerMetrics.md b/en/api/@connectum/otel/metrics/interfaces/RpcServerMetrics.md index 11b2c4dd..3e7a2372 100644 --- a/en/api/@connectum/otel/metrics/interfaces/RpcServerMetrics.md +++ b/en/api/@connectum/otel/metrics/interfaces/RpcServerMetrics.md @@ -2,7 +2,7 @@ # Interface: RpcServerMetrics -Defined in: [packages/otel/src/metrics.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L19) +Defined in: [packages/otel/src/metrics.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L19) Pre-configured RPC server metric instruments @@ -15,7 +15,7 @@ following OpenTelemetry RPC semantic conventions. > **callDuration**: `Histogram` -Defined in: [packages/otel/src/metrics.ts:21](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L21) +Defined in: [packages/otel/src/metrics.ts:21](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L21) Histogram measuring duration of RPC server calls (unit: seconds) @@ -25,7 +25,7 @@ Histogram measuring duration of RPC server calls (unit: seconds) > **requestSize**: `Histogram` -Defined in: [packages/otel/src/metrics.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L23) +Defined in: [packages/otel/src/metrics.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L23) Histogram measuring size of RPC server request messages (unit: bytes) @@ -35,6 +35,6 @@ Histogram measuring size of RPC server request messages (unit: bytes) > **responseSize**: `Histogram` -Defined in: [packages/otel/src/metrics.ts:25](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/metrics.ts#L25) +Defined in: [packages/otel/src/metrics.ts:25](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/metrics.ts#L25) Histogram measuring size of RPC server response messages (unit: bytes) diff --git a/en/api/@connectum/otel/provider/functions/buildResourceAttributes.md b/en/api/@connectum/otel/provider/functions/buildResourceAttributes.md index 8187ea27..35fc7671 100644 --- a/en/api/@connectum/otel/provider/functions/buildResourceAttributes.md +++ b/en/api/@connectum/otel/provider/functions/buildResourceAttributes.md @@ -4,7 +4,7 @@ > **buildResourceAttributes**(`inputs`): `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [packages/otel/src/provider.ts:98](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L98) +Defined in: [packages/otel/src/provider.ts:98](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L98) Build the flat resource-attribute record shared by traces, metrics, and logs. diff --git a/en/api/@connectum/otel/provider/functions/getProvider.md b/en/api/@connectum/otel/provider/functions/getProvider.md index 4506e562..8aa9033f 100644 --- a/en/api/@connectum/otel/provider/functions/getProvider.md +++ b/en/api/@connectum/otel/provider/functions/getProvider.md @@ -4,7 +4,7 @@ > **getProvider**(): `OtelProvider` -Defined in: [packages/otel/src/provider.ts:371](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L371) +Defined in: [packages/otel/src/provider.ts:371](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L371) Get the current OpenTelemetry provider. diff --git a/en/api/@connectum/otel/provider/functions/initProvider.md b/en/api/@connectum/otel/provider/functions/initProvider.md index 12c722b6..d0d317b3 100644 --- a/en/api/@connectum/otel/provider/functions/initProvider.md +++ b/en/api/@connectum/otel/provider/functions/initProvider.md @@ -4,7 +4,7 @@ > **initProvider**(`options?`): `void` -Defined in: [packages/otel/src/provider.ts:357](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L357) +Defined in: [packages/otel/src/provider.ts:357](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L357) Initialize the OpenTelemetry provider with explicit options. diff --git a/en/api/@connectum/otel/provider/functions/parseOtelResourceAttributesEnv.md b/en/api/@connectum/otel/provider/functions/parseOtelResourceAttributesEnv.md index 2ce37556..28cc374d 100644 --- a/en/api/@connectum/otel/provider/functions/parseOtelResourceAttributesEnv.md +++ b/en/api/@connectum/otel/provider/functions/parseOtelResourceAttributesEnv.md @@ -4,7 +4,7 @@ > **parseOtelResourceAttributesEnv**(`raw`): `Record`\<`string`, `string`\> -Defined in: [packages/otel/src/provider.ts:62](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L62) +Defined in: [packages/otel/src/provider.ts:62](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L62) Parse the standard `OTEL_RESOURCE_ATTRIBUTES` env var (`key1=value1,key2=value2`) into an attribute record. Malformed pairs (no diff --git a/en/api/@connectum/otel/provider/functions/shutdownProvider.md b/en/api/@connectum/otel/provider/functions/shutdownProvider.md index 0b6154b7..80332a53 100644 --- a/en/api/@connectum/otel/provider/functions/shutdownProvider.md +++ b/en/api/@connectum/otel/provider/functions/shutdownProvider.md @@ -4,7 +4,7 @@ > **shutdownProvider**(): `Promise`\<`void`\> -Defined in: [packages/otel/src/provider.ts:384](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L384) +Defined in: [packages/otel/src/provider.ts:384](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L384) Gracefully shutdown the provider and release resources. diff --git a/en/api/@connectum/otel/provider/interfaces/ProviderOptions.md b/en/api/@connectum/otel/provider/interfaces/ProviderOptions.md index 4f839811..8ea67ae4 100644 --- a/en/api/@connectum/otel/provider/interfaces/ProviderOptions.md +++ b/en/api/@connectum/otel/provider/interfaces/ProviderOptions.md @@ -2,7 +2,7 @@ # Interface: ProviderOptions -Defined in: [packages/otel/src/provider.ts:35](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L35) +Defined in: [packages/otel/src/provider.ts:35](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L35) Options for initializing the OpenTelemetry provider @@ -12,7 +12,7 @@ Options for initializing the OpenTelemetry provider > `optional` **instanceId?**: `string` -Defined in: [packages/otel/src/provider.ts:45](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L45) +Defined in: [packages/otel/src/provider.ts:45](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L45) Sets `service.instance.id` on the resource (OTel semconv). Lets a fleet of same-role processes be told apart in telemetry. Takes precedence over the @@ -24,7 +24,7 @@ same-role processes be told apart in telemetry. Takes precedence over the > `optional` **resourceAttributes?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [packages/otel/src/provider.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L51) +Defined in: [packages/otel/src/provider.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L51) Extra resource attributes merged into the resource (e.g. `device.id`, `facility`). Applied to traces, metrics, and logs alike. Takes precedence @@ -36,7 +36,7 @@ over attributes parsed from the `OTEL_RESOURCE_ATTRIBUTES` env var. > `optional` **serviceName?**: `string` -Defined in: [packages/otel/src/provider.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L37) +Defined in: [packages/otel/src/provider.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L37) Override service name (defaults to OTEL_SERVICE_NAME or npm_package_name) @@ -46,7 +46,7 @@ Override service name (defaults to OTEL_SERVICE_NAME or npm_package_name) > `optional` **serviceVersion?**: `string` -Defined in: [packages/otel/src/provider.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L39) +Defined in: [packages/otel/src/provider.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L39) Override service version (defaults to npm_package_version) @@ -56,6 +56,6 @@ Override service version (defaults to npm_package_version) > `optional` **settings?**: `Partial`\<[`OTLPSettings`](../../interfaces/OTLPSettings.md)\> -Defined in: [packages/otel/src/provider.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L53) +Defined in: [packages/otel/src/provider.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L53) Override OTLP exporter settings (defaults to env-based config) diff --git a/en/api/@connectum/otel/provider/interfaces/ResourceAttributeInputs.md b/en/api/@connectum/otel/provider/interfaces/ResourceAttributeInputs.md index 9aae0ffa..989386ff 100644 --- a/en/api/@connectum/otel/provider/interfaces/ResourceAttributeInputs.md +++ b/en/api/@connectum/otel/provider/interfaces/ResourceAttributeInputs.md @@ -2,7 +2,7 @@ # Interface: ResourceAttributeInputs -Defined in: [packages/otel/src/provider.ts:82](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L82) +Defined in: [packages/otel/src/provider.ts:82](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L82) Inputs for [buildResourceAttributes](../functions/buildResourceAttributes.md). @@ -12,7 +12,7 @@ Inputs for [buildResourceAttributes](../functions/buildResourceAttributes.md). > `optional` **env?**: `object` -Defined in: [packages/otel/src/provider.ts:88](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L88) +Defined in: [packages/otel/src/provider.ts:88](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L88) Environment source (defaults to `process.env`). @@ -30,7 +30,7 @@ Environment source (defaults to `process.env`). > `optional` **instanceId?**: `string` -Defined in: [packages/otel/src/provider.ts:85](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L85) +Defined in: [packages/otel/src/provider.ts:85](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L85) *** @@ -38,7 +38,7 @@ Defined in: [packages/otel/src/provider.ts:85](https://github.com/Connectum-Fram > `optional` **resourceAttributes?**: `Record`\<`string`, `string` \| `number` \| `boolean`\> -Defined in: [packages/otel/src/provider.ts:86](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L86) +Defined in: [packages/otel/src/provider.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L86) *** @@ -46,7 +46,7 @@ Defined in: [packages/otel/src/provider.ts:86](https://github.com/Connectum-Fram > **serviceName**: `string` -Defined in: [packages/otel/src/provider.ts:83](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L83) +Defined in: [packages/otel/src/provider.ts:83](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L83) *** @@ -54,4 +54,4 @@ Defined in: [packages/otel/src/provider.ts:83](https://github.com/Connectum-Fram > **serviceVersion**: `string` -Defined in: [packages/otel/src/provider.ts:84](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/provider.ts#L84) +Defined in: [packages/otel/src/provider.ts:84](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/provider.ts#L84) diff --git a/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md b/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md index f4f0cd08..606c4af6 100644 --- a/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md +++ b/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md @@ -4,7 +4,7 @@ > **applyAttributeFilter**(`attrs`, `filter?`): `Attributes` -Defined in: [packages/otel/src/shared.ts:198](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L198) +Defined in: [packages/otel/src/shared.ts:198](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L198) Applies an attribute filter to the given attributes. diff --git a/en/api/@connectum/otel/shared/functions/buildBaseAttributes.md b/en/api/@connectum/otel/shared/functions/buildBaseAttributes.md index 9065c9fc..6debd5bb 100644 --- a/en/api/@connectum/otel/shared/functions/buildBaseAttributes.md +++ b/en/api/@connectum/otel/shared/functions/buildBaseAttributes.md @@ -4,7 +4,7 @@ > **buildBaseAttributes**(`params`): `Record`\<`string`, `string` \| `number`\> -Defined in: [packages/otel/src/shared.ts:160](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L160) +Defined in: [packages/otel/src/shared.ts:160](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L160) Builds standard RPC base attributes per OTel semantic conventions. diff --git a/en/api/@connectum/otel/shared/functions/buildErrorAttributes.md b/en/api/@connectum/otel/shared/functions/buildErrorAttributes.md index 63528f6c..0ed168a9 100644 --- a/en/api/@connectum/otel/shared/functions/buildErrorAttributes.md +++ b/en/api/@connectum/otel/shared/functions/buildErrorAttributes.md @@ -4,7 +4,7 @@ > **buildErrorAttributes**(`error`): `Record`\<`string`, `string` \| `number`\> -Defined in: [packages/otel/src/shared.ts:131](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L131) +Defined in: [packages/otel/src/shared.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L131) Builds error-specific attributes for spans and metrics. diff --git a/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md b/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md index f89ba4c7..3ade9e4c 100644 --- a/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md +++ b/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md @@ -4,7 +4,7 @@ > **detectConnectumTransport**(`headers`): `"http"` \| `"in-process"` -Defined in: [packages/otel/src/shared.ts:187](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L187) +Defined in: [packages/otel/src/shared.ts:187](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L187) Connectum transport identifier observed from request headers. diff --git a/en/api/@connectum/otel/shared/functions/estimateMessageSize.md b/en/api/@connectum/otel/shared/functions/estimateMessageSize.md index ebdb775b..b234cfba 100644 --- a/en/api/@connectum/otel/shared/functions/estimateMessageSize.md +++ b/en/api/@connectum/otel/shared/functions/estimateMessageSize.md @@ -4,7 +4,7 @@ > **estimateMessageSize**(`message`): `number` -Defined in: [packages/otel/src/shared.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L51) +Defined in: [packages/otel/src/shared.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L51) Estimates the serialized size of a protobuf message in bytes. diff --git a/en/api/@connectum/otel/shared/functions/wrapAsyncIterable.md b/en/api/@connectum/otel/shared/functions/wrapAsyncIterable.md index bf913d8d..9da80ba8 100644 --- a/en/api/@connectum/otel/shared/functions/wrapAsyncIterable.md +++ b/en/api/@connectum/otel/shared/functions/wrapAsyncIterable.md @@ -4,7 +4,7 @@ > **wrapAsyncIterable**\<`T`\>(`iterable`, `span`, `direction`, `recordMessages`, `endSpanOnComplete?`): `AsyncGenerator`\<`T`\> -Defined in: [packages/otel/src/shared.ts:83](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L83) +Defined in: [packages/otel/src/shared.ts:83](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L83) Wraps an AsyncIterable to track streaming messages with OTel span events. diff --git a/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md b/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md index 16f06778..95f05eac 100644 --- a/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md +++ b/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md @@ -2,7 +2,7 @@ # Interface: BaseAttributeParams -Defined in: [packages/otel/src/shared.ts:147](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L147) +Defined in: [packages/otel/src/shared.ts:147](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L147) Parameters for building base RPC attributes. @@ -12,7 +12,7 @@ Parameters for building base RPC attributes. > **method**: `string` -Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L149) +Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L149) *** @@ -20,7 +20,7 @@ Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Frame > **serverAddress**: `string` -Defined in: [packages/otel/src/shared.ts:150](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L150) +Defined in: [packages/otel/src/shared.ts:150](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L150) *** @@ -28,7 +28,7 @@ Defined in: [packages/otel/src/shared.ts:150](https://github.com/Connectum-Frame > `optional` **serverPort?**: `number` -Defined in: [packages/otel/src/shared.ts:151](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L151) +Defined in: [packages/otel/src/shared.ts:151](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L151) *** @@ -36,4 +36,4 @@ Defined in: [packages/otel/src/shared.ts:151](https://github.com/Connectum-Frame > **service**: `string` -Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/shared.ts#L148) +Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/shared.ts#L148) diff --git a/en/api/@connectum/otel/traceAll/functions/traceAll.md b/en/api/@connectum/otel/traceAll/functions/traceAll.md index 21de3f33..e6b5922e 100644 --- a/en/api/@connectum/otel/traceAll/functions/traceAll.md +++ b/en/api/@connectum/otel/traceAll/functions/traceAll.md @@ -4,7 +4,7 @@ > **traceAll**\<`T`\>(`target`, `options?`): `T` -Defined in: [packages/otel/src/traceAll.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/traceAll.ts#L36) +Defined in: [packages/otel/src/traceAll.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/traceAll.ts#L36) Wraps all methods of an object in OpenTelemetry spans using ES6 Proxy. diff --git a/en/api/@connectum/otel/traced/functions/traced.md b/en/api/@connectum/otel/traced/functions/traced.md index 00044ab0..4cc86f00 100644 --- a/en/api/@connectum/otel/traced/functions/traced.md +++ b/en/api/@connectum/otel/traced/functions/traced.md @@ -4,7 +4,7 @@ > **traced**\<`T`\>(`fn`, `options?`): `T` -Defined in: [packages/otel/src/traced.ts:31](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/traced.ts#L31) +Defined in: [packages/otel/src/traced.ts:31](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/traced.ts#L31) Wraps a function in an OpenTelemetry span. diff --git a/en/api/@connectum/otel/tracer/functions/getTracer.md b/en/api/@connectum/otel/tracer/functions/getTracer.md index c43e98ea..370b7d37 100644 --- a/en/api/@connectum/otel/tracer/functions/getTracer.md +++ b/en/api/@connectum/otel/tracer/functions/getTracer.md @@ -4,7 +4,7 @@ > **getTracer**(): [`Tracer`](../../interfaces/Tracer.md) -Defined in: [packages/otel/src/tracer.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/tracer.ts#L14) +Defined in: [packages/otel/src/tracer.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/tracer.ts#L14) Returns the global Tracer instance. Lazily initializes the OTel provider on first call. diff --git a/en/api/@connectum/otel/type-aliases/ArgsFilter.md b/en/api/@connectum/otel/type-aliases/ArgsFilter.md index 760eb296..af7d3eaf 100644 --- a/en/api/@connectum/otel/type-aliases/ArgsFilter.md +++ b/en/api/@connectum/otel/type-aliases/ArgsFilter.md @@ -4,7 +4,7 @@ > **ArgsFilter** = (`args`) => `unknown`[] -Defined in: [packages/otel/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L94) +Defined in: [packages/otel/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L94) Args filter for traced() -- sanitize/transform function arguments before recording diff --git a/en/api/@connectum/otel/type-aliases/ExporterType.md b/en/api/@connectum/otel/type-aliases/ExporterType.md index 6ac2a1ee..82e3ea49 100644 --- a/en/api/@connectum/otel/type-aliases/ExporterType.md +++ b/en/api/@connectum/otel/type-aliases/ExporterType.md @@ -4,7 +4,7 @@ > **ExporterType** = *typeof* [`ExporterType`](../variables/ExporterType.md)\[keyof *typeof* [`ExporterType`](../variables/ExporterType.md)\] -Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L19) +Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L19) Available exporter types diff --git a/en/api/@connectum/otel/type-aliases/MethodArgsFilter.md b/en/api/@connectum/otel/type-aliases/MethodArgsFilter.md index d86d811f..0836dba3 100644 --- a/en/api/@connectum/otel/type-aliases/MethodArgsFilter.md +++ b/en/api/@connectum/otel/type-aliases/MethodArgsFilter.md @@ -4,7 +4,7 @@ > **MethodArgsFilter** = (`methodName`, `args`) => `unknown`[] -Defined in: [packages/otel/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L99) +Defined in: [packages/otel/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L99) Args filter for traceAll() -- has access to method name diff --git a/en/api/@connectum/otel/type-aliases/OtelAttributeFilter.md b/en/api/@connectum/otel/type-aliases/OtelAttributeFilter.md index 0ff218e4..7c9ece02 100644 --- a/en/api/@connectum/otel/type-aliases/OtelAttributeFilter.md +++ b/en/api/@connectum/otel/type-aliases/OtelAttributeFilter.md @@ -4,7 +4,7 @@ > **OtelAttributeFilter** = (`key`, `value`) => `boolean` -Defined in: [packages/otel/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L24) +Defined in: [packages/otel/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L24) Filter callback to exclude specific attributes from spans/metrics diff --git a/en/api/@connectum/otel/type-aliases/OtelFilter.md b/en/api/@connectum/otel/type-aliases/OtelFilter.md index 1d78b508..c366017d 100644 --- a/en/api/@connectum/otel/type-aliases/OtelFilter.md +++ b/en/api/@connectum/otel/type-aliases/OtelFilter.md @@ -4,7 +4,7 @@ > **OtelFilter** = (`context`) => `boolean` -Defined in: [packages/otel/src/types.ts:15](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/types.ts#L15) +Defined in: [packages/otel/src/types.ts:15](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/types.ts#L15) Filter callback to skip specific RPC requests from instrumentation diff --git a/en/api/@connectum/otel/variables/ExporterType.md b/en/api/@connectum/otel/variables/ExporterType.md index bde0fae8..b161fdea 100644 --- a/en/api/@connectum/otel/variables/ExporterType.md +++ b/en/api/@connectum/otel/variables/ExporterType.md @@ -4,7 +4,7 @@ > `const` **ExporterType**: `object` -Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/otel/src/config.ts#L19) +Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/otel/src/config.ts#L19) Available exporter types diff --git a/en/api/@connectum/reflection/functions/Reflection.md b/en/api/@connectum/reflection/functions/Reflection.md index 2f548289..518f2978 100644 --- a/en/api/@connectum/reflection/functions/Reflection.md +++ b/en/api/@connectum/reflection/functions/Reflection.md @@ -4,7 +4,7 @@ > **Reflection**(): `ProtocolRegistration` -Defined in: [Reflection.ts:43](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/reflection/src/Reflection.ts#L43) +Defined in: [Reflection.ts:43](https://github.com/Connectum-Framework/connectum/blob/main/packages/reflection/src/Reflection.ts#L43) Create reflection protocol registration diff --git a/en/api/@connectum/reflection/functions/collectFileProtos.md b/en/api/@connectum/reflection/functions/collectFileProtos.md index cd834a67..67a261e1 100644 --- a/en/api/@connectum/reflection/functions/collectFileProtos.md +++ b/en/api/@connectum/reflection/functions/collectFileProtos.md @@ -4,7 +4,7 @@ > **collectFileProtos**(`files`): `FileDescriptorProto`[] -Defined in: [utils.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/reflection/src/utils.ts#L19) +Defined in: [utils.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/reflection/src/utils.ts#L19) Recursively collect FileDescriptorProto objects from DescFile entries, including transitive dependencies. diff --git a/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md b/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md index 35a4493e..3160d96a 100644 --- a/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md +++ b/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md @@ -4,7 +4,7 @@ > **assertConnectError**(`error`, `expectedCode`, `messagePattern?`): `asserts error is ConnectError` -Defined in: [assertions.ts:44](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/assertions.ts#L44) +Defined in: [assertions.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/assertions.ts#L44) Assert that a thrown value is a ConnectError with the expected gRPC status code and, optionally, a message matching a pattern. diff --git a/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md b/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md index 6523caf0..338b7ab2 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md +++ b/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md @@ -4,7 +4,7 @@ > **createFakeMethod**(`service`, `name`, `options?`): `DescMethod` -Defined in: [fake-service.ts:72](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/fake-service.ts#L72) +Defined in: [fake-service.ts:72](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/fake-service.ts#L72) Create a fake DescMethod descriptor attached to a service. diff --git a/en/api/@connectum/test-fixtures/index/functions/createFakeService.md b/en/api/@connectum/test-fixtures/index/functions/createFakeService.md index 8fd9852f..af8ae2f5 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createFakeService.md +++ b/en/api/@connectum/test-fixtures/index/functions/createFakeService.md @@ -4,7 +4,7 @@ > **createFakeService**(`options?`): `DescService` -Defined in: [fake-service.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/fake-service.ts#L34) +Defined in: [fake-service.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/fake-service.ts#L34) Create a fake DescService descriptor for testing. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md b/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md index 1904a12b..c5202b84 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md @@ -4,7 +4,7 @@ > **createMockDescField**(`localName`, `options?`): `DescField` -Defined in: [mock-desc.ts:62](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-desc.ts#L62) +Defined in: [mock-desc.ts:62](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-desc.ts#L62) Create a mock DescField descriptor. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md b/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md index 727dfe39..1cb48cdd 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md @@ -4,7 +4,7 @@ > **createMockDescMessage**(`typeName`, `options?`): `DescMessage` -Defined in: [mock-desc.ts:109](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-desc.ts#L109) +Defined in: [mock-desc.ts:109](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-desc.ts#L109) Create a mock DescMessage descriptor with all required structural properties. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md b/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md index 62c3d8b1..65c83994 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md @@ -4,7 +4,7 @@ > **createMockDescMethod**(`name`, `options?`): `DescMethod` -Defined in: [mock-desc.ts:172](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-desc.ts#L172) +Defined in: [mock-desc.ts:172](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-desc.ts#L172) Create a mock DescMethod descriptor. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockFn.md b/en/api/@connectum/test-fixtures/index/functions/createMockFn.md index d3a53edf..0b81abcd 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockFn.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockFn.md @@ -4,7 +4,7 @@ > **createMockFn**\<`F`\>(`impl`): [`MockFn`](../interfaces/MockFn.md)\<`F`\> -Defined in: [mock-compat.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-compat.ts#L54) +Defined in: [mock-compat.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-compat.ts#L54) Create a portable mock function that wraps `impl` and records every call. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockNext.md b/en/api/@connectum/test-fixtures/index/functions/createMockNext.md index 69a05222..bf5ebb78 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockNext.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockNext.md @@ -4,7 +4,7 @@ > **createMockNext**(`options?`): `any` -Defined in: [mock-next.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-next.ts#L36) +Defined in: [mock-next.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-next.ts#L36) Create a mock `next` handler that resolves with a successful response. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md b/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md index ff0171e3..80b589de 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md @@ -4,7 +4,7 @@ > **createMockNextError**(`code`, `message?`): `any` -Defined in: [mock-next.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-next.ts#L68) +Defined in: [mock-next.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-next.ts#L68) Create a mock `next` handler that always throws a ConnectError. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md b/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md index 09196a8e..bd2d9074 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md @@ -4,7 +4,7 @@ > **createMockNextSlow**(`delay`, `options?`): `any` -Defined in: [mock-next.ts:93](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-next.ts#L93) +Defined in: [mock-next.ts:93](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-next.ts#L93) Create a mock `next` handler that resolves after a configurable delay. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md b/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md index 910ef972..699e3799 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md @@ -4,7 +4,7 @@ > **createMockRequest**(`options?`): `any` -Defined in: [mock-request.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-request.ts#L34) +Defined in: [mock-request.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-request.ts#L34) Create a mock ConnectRPC [UnaryRequest](https://connectrpc.com/docs/node/interceptors) object suitable for testing interceptors. diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockStream.md b/en/api/@connectum/test-fixtures/index/functions/createMockStream.md index 48abe545..82d8ab72 100644 --- a/en/api/@connectum/test-fixtures/index/functions/createMockStream.md +++ b/en/api/@connectum/test-fixtures/index/functions/createMockStream.md @@ -4,7 +4,7 @@ > **createMockStream**\<`T`\>(`items`, `options?`): `AsyncIterable`\<`T`\> -Defined in: [mock-stream.ts:35](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-stream.ts#L35) +Defined in: [mock-stream.ts:35](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-stream.ts#L35) Create an AsyncIterable that yields `items` sequentially. diff --git a/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md b/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md index 8107c28d..1ad6711e 100644 --- a/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md +++ b/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md @@ -2,7 +2,7 @@ # Interface: MockCall\ -Defined in: [mock-compat.ts:15](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-compat.ts#L15) +Defined in: [mock-compat.ts:15](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-compat.ts#L15) A single recorded invocation of a [MockFn](MockFn.md). @@ -18,6 +18,6 @@ A single recorded invocation of a [MockFn](MockFn.md). > `readonly` **arguments**: `Args` -Defined in: [mock-compat.ts:17](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-compat.ts#L17) +Defined in: [mock-compat.ts:17](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-compat.ts#L17) The arguments passed to the mock function. diff --git a/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md b/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md index 2787e273..d6742c77 100644 --- a/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md +++ b/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md @@ -2,7 +2,7 @@ # Interface: MockFn()\ -Defined in: [mock-compat.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-compat.ts#L27) +Defined in: [mock-compat.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-compat.ts#L27) A callable spy that records every invocation. @@ -17,7 +17,7 @@ that Connectum testing utilities rely on. > **MockFn**(...`args`): `ReturnType`\<`F`\> -Defined in: [mock-compat.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-compat.ts#L28) +Defined in: [mock-compat.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-compat.ts#L28) A callable spy that records every invocation. @@ -40,7 +40,7 @@ that Connectum testing utilities rely on. > `readonly` **mock**: `object` -Defined in: [mock-compat.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/mock-compat.ts#L30) +Defined in: [mock-compat.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/mock-compat.ts#L30) Spy metadata. diff --git a/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md index 72061d6b..3d8f4211 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md @@ -2,7 +2,7 @@ # Interface: FakeMethodOptions -Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L102) +Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L102) Options for createFakeMethod. @@ -12,7 +12,7 @@ Options for createFakeMethod. > `optional` **methodKind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` -Defined in: [types.ts:104](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L104) +Defined in: [types.ts:104](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L104) Method kind. Default: `'unary'` @@ -22,6 +22,6 @@ Method kind. Default: `'unary'` > `optional` **register?**: `boolean` -Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L106) +Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L106) Whether to register the method in service.methods. Default: `false` diff --git a/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md index 2c777884..8ad836eb 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md @@ -2,7 +2,7 @@ # Interface: FakeServiceOptions -Defined in: [types.ts:94](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L94) +Defined in: [types.ts:94](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L94) Options for createFakeService. @@ -12,7 +12,7 @@ Options for createFakeService. > `optional` **name?**: `string` -Defined in: [types.ts:98](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L98) +Defined in: [types.ts:98](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L98) Service name (short). Default: derived from typeName @@ -22,6 +22,6 @@ Service name (short). Default: derived from typeName > `optional` **typeName?**: `string` -Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L96) Service type name. Default: `'test.v1.TestService'` diff --git a/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md index cd2e20a5..9b5b19d8 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md @@ -2,7 +2,7 @@ # Interface: MockDescFieldOptions -Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L58) Options for createMockDescField. @@ -12,7 +12,7 @@ Options for createMockDescField. > `optional` **fieldNumber?**: `number` -Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L62) Proto field number. Default: auto-incremented @@ -22,7 +22,7 @@ Proto field number. Default: auto-incremented > `optional` **isSensitive?**: `boolean` -Defined in: [types.ts:60](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L60) +Defined in: [types.ts:60](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L60) Mark field as sensitive (for redact interceptor). Default: `false` @@ -32,6 +32,6 @@ Mark field as sensitive (for redact interceptor). Default: `false` > `optional` **type?**: `string` -Defined in: [types.ts:64](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L64) +Defined in: [types.ts:64](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L64) Field scalar type. Default: `'string'` diff --git a/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md index 4a990d41..4ee2bfd5 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md @@ -2,7 +2,7 @@ # Interface: MockDescMessageOptions -Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L46) +Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L46) Options for createMockDescMessage. @@ -12,7 +12,7 @@ Options for createMockDescMessage. > `optional` **fields?**: `object`[] -Defined in: [types.ts:48](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L48) +Defined in: [types.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L48) Field definitions. Default: `[]` @@ -34,6 +34,6 @@ Field definitions. Default: `[]` > `optional` **oneofs?**: `string`[] -Defined in: [types.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L54) +Defined in: [types.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L54) Oneof group names. Default: `[]` diff --git a/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md index 8b06ed44..d4460d07 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md @@ -2,7 +2,7 @@ # Interface: MockDescMethodOptions -Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L68) +Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L68) Options for createMockDescMethod. @@ -12,7 +12,7 @@ Options for createMockDescMethod. > `optional` **input?**: `DescMessage` -Defined in: [types.ts:70](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L70) +Defined in: [types.ts:70](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L70) Input message descriptor. @@ -22,7 +22,7 @@ Input message descriptor. > `optional` **kind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` -Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L74) +Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L74) Method kind. Default: `'unary'` @@ -32,7 +32,7 @@ Method kind. Default: `'unary'` > `optional` **output?**: `DescMessage` -Defined in: [types.ts:72](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L72) +Defined in: [types.ts:72](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L72) Output message descriptor. @@ -42,6 +42,6 @@ Output message descriptor. > `optional` **useSensitiveRedaction?**: `boolean` -Defined in: [types.ts:76](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L76) +Defined in: [types.ts:76](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L76) Enable sensitive field redaction for this method. Default: `false` diff --git a/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md index 16b91d2e..389c0b54 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md @@ -2,7 +2,7 @@ # Interface: MockNextOptions -Defined in: [types.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L34) +Defined in: [types.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L34) Options for createMockNext and createMockNextSlow. @@ -12,7 +12,7 @@ Options for createMockNext and createMockNextSlow. > `optional` **message?**: `unknown` -Defined in: [types.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L36) +Defined in: [types.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L36) Response message. Default: `{ result: 'success' }` @@ -22,6 +22,6 @@ Response message. Default: `{ result: 'success' }` > `optional` **stream?**: `boolean` -Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L38) Streaming response flag. Default: `false` diff --git a/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md index 181873de..89299e2b 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md @@ -2,7 +2,7 @@ # Interface: MockRequestOptions -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L14) Options for createMockRequest. @@ -12,7 +12,7 @@ Options for createMockRequest. > `optional` **headers?**: `Headers` -Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L26) Request headers. Default: `new Headers()` @@ -22,7 +22,7 @@ Request headers. Default: `new Headers()` > `optional` **message?**: `unknown` -Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L20) +Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L20) Request message payload. Default: `{}` @@ -32,7 +32,7 @@ Request message payload. Default: `{}` > `optional` **method?**: `string` -Defined in: [types.ts:18](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L18) +Defined in: [types.ts:18](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L18) Method name. Default: `'TestMethod'` @@ -42,7 +42,7 @@ Method name. Default: `'TestMethod'` > `optional` **service?**: `string` -Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L16) Service type name. Default: `'test.TestService'` @@ -52,7 +52,7 @@ Service type name. Default: `'test.TestService'` > `optional` **stream?**: `boolean` -Defined in: [types.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L22) +Defined in: [types.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L22) Streaming request flag. Default: `false` @@ -62,6 +62,6 @@ Streaming request flag. Default: `false` > `optional` **url?**: `string` -Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L24) +Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L24) Request URL. Auto-generated from service/method if omitted. diff --git a/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md index b4cb3564..24b8953e 100644 --- a/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md @@ -2,7 +2,7 @@ # Interface: MockStreamOptions -Defined in: [types.ts:84](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L84) +Defined in: [types.ts:84](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L84) Options for createMockStream. @@ -12,6 +12,6 @@ Options for createMockStream. > `optional` **delayMs?**: `number` -Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/test-fixtures/src/types.ts#L86) +Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/main/packages/test-fixtures/src/types.ts#L86) Delay in milliseconds between yielded items. diff --git a/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md b/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md index 08a43665..d7205b7d 100644 --- a/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md +++ b/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md @@ -2,7 +2,7 @@ # Class: InMemoryMetricCollector -Defined in: [testing/src/otel-collectors.ts:191](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L191) +Defined in: [testing/src/otel-collectors.ts:191](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L191) In-memory metric collector. Owns its own `MeterProvider` and periodic reader. `flush()` performs a forced collect+export cycle synchronously @@ -14,7 +14,7 @@ reader. `flush()` performs a forced collect+export cycle synchronously > **new InMemoryMetricCollector**(): `InMemoryMetricCollector` -Defined in: [testing/src/otel-collectors.ts:196](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L196) +Defined in: [testing/src/otel-collectors.ts:196](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L196) #### Returns @@ -26,7 +26,7 @@ Defined in: [testing/src/otel-collectors.ts:196](https://github.com/Connectum-Fr > `readonly` **exporter**: `InMemoryMetricExporter` -Defined in: [testing/src/otel-collectors.ts:192](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L192) +Defined in: [testing/src/otel-collectors.ts:192](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L192) *** @@ -34,7 +34,7 @@ Defined in: [testing/src/otel-collectors.ts:192](https://github.com/Connectum-Fr > `readonly` **provider**: `MeterProvider` -Defined in: [testing/src/otel-collectors.ts:193](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L193) +Defined in: [testing/src/otel-collectors.ts:193](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L193) *** @@ -42,7 +42,7 @@ Defined in: [testing/src/otel-collectors.ts:193](https://github.com/Connectum-Fr > `readonly` **reader**: `PeriodicExportingMetricReader` -Defined in: [testing/src/otel-collectors.ts:194](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L194) +Defined in: [testing/src/otel-collectors.ts:194](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L194) ## Methods @@ -50,7 +50,7 @@ Defined in: [testing/src/otel-collectors.ts:194](https://github.com/Connectum-Fr > **dispose**(): `Promise`\<`void`\> -Defined in: [testing/src/otel-collectors.ts:229](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L229) +Defined in: [testing/src/otel-collectors.ts:229](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L229) #### Returns @@ -62,7 +62,7 @@ Defined in: [testing/src/otel-collectors.ts:229](https://github.com/Connectum-Fr > **flush**(): `Promise`\<[`NormalizedMetric`](../interfaces/NormalizedMetric.md)[]\> -Defined in: [testing/src/otel-collectors.ts:208](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L208) +Defined in: [testing/src/otel-collectors.ts:208](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L208) #### Returns @@ -74,7 +74,7 @@ Defined in: [testing/src/otel-collectors.ts:208](https://github.com/Connectum-Fr > **reset**(): `void` -Defined in: [testing/src/otel-collectors.ts:225](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L225) +Defined in: [testing/src/otel-collectors.ts:225](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L225) #### Returns diff --git a/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md b/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md index be1bc270..392114ba 100644 --- a/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md +++ b/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md @@ -2,7 +2,7 @@ # Class: InMemorySpanCollector -Defined in: [testing/src/otel-collectors.ts:147](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L147) +Defined in: [testing/src/otel-collectors.ts:147](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L147) In-memory span collector. Owns its own `BasicTracerProvider` so that different scenarios cannot cross-contaminate. @@ -17,7 +17,7 @@ Callers wishing to register the provider globally (so that > **new InMemorySpanCollector**(): `InMemorySpanCollector` -Defined in: [testing/src/otel-collectors.ts:151](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L151) +Defined in: [testing/src/otel-collectors.ts:151](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L151) #### Returns @@ -29,7 +29,7 @@ Defined in: [testing/src/otel-collectors.ts:151](https://github.com/Connectum-Fr > `readonly` **exporter**: `InMemorySpanExporter` -Defined in: [testing/src/otel-collectors.ts:148](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L148) +Defined in: [testing/src/otel-collectors.ts:148](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L148) *** @@ -37,7 +37,7 @@ Defined in: [testing/src/otel-collectors.ts:148](https://github.com/Connectum-Fr > `readonly` **provider**: `BasicTracerProvider` -Defined in: [testing/src/otel-collectors.ts:149](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L149) +Defined in: [testing/src/otel-collectors.ts:149](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L149) ## Methods @@ -45,7 +45,7 @@ Defined in: [testing/src/otel-collectors.ts:149](https://github.com/Connectum-Fr > **dispose**(): `Promise`\<`void`\> -Defined in: [testing/src/otel-collectors.ts:181](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L181) +Defined in: [testing/src/otel-collectors.ts:181](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L181) #### Returns @@ -57,7 +57,7 @@ Defined in: [testing/src/otel-collectors.ts:181](https://github.com/Connectum-Fr > **flush**(): [`NormalizedSpan`](../interfaces/NormalizedSpan.md)[] -Defined in: [testing/src/otel-collectors.ts:165](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L165) +Defined in: [testing/src/otel-collectors.ts:165](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L165) Returns normalized finished spans collected so far. @@ -75,7 +75,7 @@ for the parity structural diff. > **reset**(): `void` -Defined in: [testing/src/otel-collectors.ts:177](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L177) +Defined in: [testing/src/otel-collectors.ts:177](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L177) Clear the internal buffer. diff --git a/en/api/@connectum/testing/index/functions/createLocalClient.md b/en/api/@connectum/testing/index/functions/createLocalClient.md index 38a8dd62..4d80856f 100644 --- a/en/api/@connectum/testing/index/functions/createLocalClient.md +++ b/en/api/@connectum/testing/index/functions/createLocalClient.md @@ -4,7 +4,7 @@ > **createLocalClient**\<`T`\>(`server`, `service`): `Client`\<`T`\> -Defined in: [testing/src/createLocalClient.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/createLocalClient.ts#L38) +Defined in: [testing/src/createLocalClient.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/createLocalClient.ts#L38) Create an in-process ConnectRPC client for a service registered on the given Server. diff --git a/en/api/@connectum/testing/index/functions/createMockContext.md b/en/api/@connectum/testing/index/functions/createMockContext.md index aa8c0b37..98e9bb2b 100644 --- a/en/api/@connectum/testing/index/functions/createMockContext.md +++ b/en/api/@connectum/testing/index/functions/createMockContext.md @@ -4,7 +4,7 @@ > **createMockContext**(`options`): `Context` -Defined in: [testing/src/mockContext.ts:68](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L68) +Defined in: [testing/src/mockContext.ts:68](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L68) Create a Context whose `ctx.call` / `ctx.stream` resolve against the given mocks. Pass it as the second argument to a handler under test. diff --git a/en/api/@connectum/testing/index/functions/createTestServer.md b/en/api/@connectum/testing/index/functions/createTestServer.md index c39ddce9..d0f69042 100644 --- a/en/api/@connectum/testing/index/functions/createTestServer.md +++ b/en/api/@connectum/testing/index/functions/createTestServer.md @@ -4,7 +4,7 @@ > **createTestServer**(`options`): `Promise`\<[`TestServer`](../../types/interfaces/TestServer.md)\> -Defined in: [testing/src/test-server.ts:33](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/test-server.ts#L33) +Defined in: [testing/src/test-server.ts:33](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/test-server.ts#L33) Create and start a test server on a random (or specified) port. diff --git a/en/api/@connectum/testing/index/functions/mockResolver.md b/en/api/@connectum/testing/index/functions/mockResolver.md index 43e4093e..0667bc81 100644 --- a/en/api/@connectum/testing/index/functions/mockResolver.md +++ b/en/api/@connectum/testing/index/functions/mockResolver.md @@ -4,7 +4,7 @@ > **mockResolver**(`mocks`): `RemoteResolver` -Defined in: [testing/src/mockResolver.ts:54](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockResolver.ts#L54) +Defined in: [testing/src/mockResolver.ts:54](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockResolver.ts#L54) Build a RemoteResolver that serves the given mocks in-process. Returns `null` for any service not in the mock set (so it composes with real diff --git a/en/api/@connectum/testing/index/functions/mockService.md b/en/api/@connectum/testing/index/functions/mockService.md index 5142be2c..d126ffd4 100644 --- a/en/api/@connectum/testing/index/functions/mockService.md +++ b/en/api/@connectum/testing/index/functions/mockService.md @@ -4,7 +4,7 @@ > **mockService**\<`S`\>(`service`, `impl`): [`MockService`](../interfaces/MockService.md) -Defined in: [testing/src/mockResolver.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockResolver.ts#L38) +Defined in: [testing/src/mockResolver.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockResolver.ts#L38) Type-safe constructor for a [MockService](../interfaces/MockService.md). Pairs a service descriptor with handlers typed against it. diff --git a/en/api/@connectum/testing/index/functions/withTestServer.md b/en/api/@connectum/testing/index/functions/withTestServer.md index 8159fa3f..c62db15b 100644 --- a/en/api/@connectum/testing/index/functions/withTestServer.md +++ b/en/api/@connectum/testing/index/functions/withTestServer.md @@ -4,7 +4,7 @@ > **withTestServer**\<`T`\>(`options`, `testFn`): `Promise`\<`T`\> -Defined in: [testing/src/test-server.ts:93](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/test-server.ts#L93) +Defined in: [testing/src/test-server.ts:93](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/test-server.ts#L93) Run a test function with an auto-managed test server. diff --git a/en/api/@connectum/testing/index/interfaces/CreateMockContextOptions.md b/en/api/@connectum/testing/index/interfaces/CreateMockContextOptions.md index 4df46242..5e56acc8 100644 --- a/en/api/@connectum/testing/index/interfaces/CreateMockContextOptions.md +++ b/en/api/@connectum/testing/index/interfaces/CreateMockContextOptions.md @@ -2,7 +2,7 @@ # Interface: CreateMockContextOptions -Defined in: [testing/src/mockContext.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L22) +Defined in: [testing/src/mockContext.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L22) Options for [createMockContext](../functions/createMockContext.md). @@ -12,7 +12,7 @@ Options for [createMockContext](../functions/createMockContext.md). > `readonly` **catalog**: `ServiceCatalog` -Defined in: [testing/src/mockContext.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L24) +Defined in: [testing/src/mockContext.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L24) The catalog the handler-under-test calls into. @@ -22,7 +22,7 @@ The catalog the handler-under-test calls into. > `readonly` **mocks**: readonly [`MockService`](MockService.md)[] -Defined in: [testing/src/mockContext.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L26) +Defined in: [testing/src/mockContext.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L26) Mock implementations served via the catalog's resolver path. @@ -32,7 +32,7 @@ Mock implementations served via the catalog's resolver path. > `readonly` `optional` **outgoingInterceptors?**: readonly `Interceptor`[] -Defined in: [testing/src/mockContext.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L28) +Defined in: [testing/src/mockContext.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L28) Optional outgoing interceptors (applied exactly as in production). @@ -42,7 +42,7 @@ Optional outgoing interceptors (applied exactly as in production). > `readonly` `optional` **propagateHeaders?**: readonly `string`[] -Defined in: [testing/src/mockContext.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L34) +Defined in: [testing/src/mockContext.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L34) Optional header names propagated onto outgoing calls (default none). @@ -52,7 +52,7 @@ Optional header names propagated onto outgoing calls (default none). > `readonly` `optional` **requestHeader?**: `HeadersInit` -Defined in: [testing/src/mockContext.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L30) +Defined in: [testing/src/mockContext.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L30) Optional inbound headers (seen by `ctx.requestHeader` + header propagation). @@ -62,6 +62,6 @@ Optional inbound headers (seen by `ctx.requestHeader` + header propagation). > `readonly` `optional` **timeoutMs?**: `number` -Defined in: [testing/src/mockContext.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockContext.ts#L32) +Defined in: [testing/src/mockContext.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockContext.ts#L32) Optional inbound deadline in ms (drives the `ctx.timeoutMs()` cascade). diff --git a/en/api/@connectum/testing/index/interfaces/MockService.md b/en/api/@connectum/testing/index/interfaces/MockService.md index 33ce85d3..572f3073 100644 --- a/en/api/@connectum/testing/index/interfaces/MockService.md +++ b/en/api/@connectum/testing/index/interfaces/MockService.md @@ -2,7 +2,7 @@ # Interface: MockService -Defined in: [testing/src/mockResolver.ts:22](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockResolver.ts#L22) +Defined in: [testing/src/mockResolver.ts:22](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockResolver.ts#L22) A mocked service: its proto descriptor paired with a (partial) implementation. @@ -12,7 +12,7 @@ A mocked service: its proto descriptor paired with a (partial) implementation. > `readonly` **impl**: `Partial`\<`ServiceImpl`\<`DescService`\>\> -Defined in: [testing/src/mockResolver.ts:24](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockResolver.ts#L24) +Defined in: [testing/src/mockResolver.ts:24](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockResolver.ts#L24) *** @@ -20,4 +20,4 @@ Defined in: [testing/src/mockResolver.ts:24](https://github.com/Connectum-Framew > `readonly` **service**: `DescService` -Defined in: [testing/src/mockResolver.ts:23](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockResolver.ts#L23) +Defined in: [testing/src/mockResolver.ts:23](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockResolver.ts#L23) diff --git a/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md b/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md index 5fbaeaf2..3018a5eb 100644 --- a/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md +++ b/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md @@ -2,7 +2,7 @@ # Interface: NormalizedMetric -Defined in: [testing/src/otel-collectors.ts:48](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L48) +Defined in: [testing/src/otel-collectors.ts:48](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L48) Structural representation of a single metric data point. @@ -12,7 +12,7 @@ Structural representation of a single metric data point. > **description**: `string` -Defined in: [testing/src/otel-collectors.ts:50](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L50) +Defined in: [testing/src/otel-collectors.ts:50](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L50) *** @@ -20,7 +20,7 @@ Defined in: [testing/src/otel-collectors.ts:50](https://github.com/Connectum-Fra > **name**: `string` -Defined in: [testing/src/otel-collectors.ts:49](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L49) +Defined in: [testing/src/otel-collectors.ts:49](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L49) *** @@ -28,7 +28,7 @@ Defined in: [testing/src/otel-collectors.ts:49](https://github.com/Connectum-Fra > **points**: `object`[] -Defined in: [testing/src/otel-collectors.ts:53](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L53) +Defined in: [testing/src/otel-collectors.ts:53](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L53) #### attributes @@ -44,7 +44,7 @@ Defined in: [testing/src/otel-collectors.ts:53](https://github.com/Connectum-Fra > **type**: `string` -Defined in: [testing/src/otel-collectors.ts:52](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L52) +Defined in: [testing/src/otel-collectors.ts:52](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L52) *** @@ -52,4 +52,4 @@ Defined in: [testing/src/otel-collectors.ts:52](https://github.com/Connectum-Fra > **unit**: `string` -Defined in: [testing/src/otel-collectors.ts:51](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L51) +Defined in: [testing/src/otel-collectors.ts:51](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L51) diff --git a/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md b/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md index 5e8c5529..c67302df 100644 --- a/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md +++ b/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md @@ -2,7 +2,7 @@ # Interface: NormalizedSpan -Defined in: [testing/src/otel-collectors.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L34) +Defined in: [testing/src/otel-collectors.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L34) Structural, transport-agnostic representation of a span suitable for `deepEqual`. @@ -12,7 +12,7 @@ Structural, transport-agnostic representation of a span suitable for `deepEqual` > **attributes**: `Record`\<`string`, `unknown`\> -Defined in: [testing/src/otel-collectors.ts:37](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L37) +Defined in: [testing/src/otel-collectors.ts:37](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L37) *** @@ -20,7 +20,7 @@ Defined in: [testing/src/otel-collectors.ts:37](https://github.com/Connectum-Fra > **events**: `object`[] -Defined in: [testing/src/otel-collectors.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L38) +Defined in: [testing/src/otel-collectors.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L38) #### attributes @@ -36,7 +36,7 @@ Defined in: [testing/src/otel-collectors.ts:38](https://github.com/Connectum-Fra > **kind**: `number` -Defined in: [testing/src/otel-collectors.ts:36](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L36) +Defined in: [testing/src/otel-collectors.ts:36](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L36) *** @@ -44,7 +44,7 @@ Defined in: [testing/src/otel-collectors.ts:36](https://github.com/Connectum-Fra > **name**: `string` -Defined in: [testing/src/otel-collectors.ts:35](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L35) +Defined in: [testing/src/otel-collectors.ts:35](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L35) *** @@ -52,7 +52,7 @@ Defined in: [testing/src/otel-collectors.ts:35](https://github.com/Connectum-Fra > **parentSpanId**: `string` \| `undefined` -Defined in: [testing/src/otel-collectors.ts:42](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L42) +Defined in: [testing/src/otel-collectors.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L42) *** @@ -60,7 +60,7 @@ Defined in: [testing/src/otel-collectors.ts:42](https://github.com/Connectum-Fra > **spanId**: `string` -Defined in: [testing/src/otel-collectors.ts:41](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L41) +Defined in: [testing/src/otel-collectors.ts:41](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L41) *** @@ -68,7 +68,7 @@ Defined in: [testing/src/otel-collectors.ts:41](https://github.com/Connectum-Fra > **status**: `object` -Defined in: [testing/src/otel-collectors.ts:39](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L39) +Defined in: [testing/src/otel-collectors.ts:39](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L39) #### code @@ -84,4 +84,4 @@ Defined in: [testing/src/otel-collectors.ts:39](https://github.com/Connectum-Fra > **traceId**: `string` -Defined in: [testing/src/otel-collectors.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L40) +Defined in: [testing/src/otel-collectors.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L40) diff --git a/en/api/@connectum/testing/index/variables/MOCK_RESPONSE_HEADER.md b/en/api/@connectum/testing/index/variables/MOCK_RESPONSE_HEADER.md index 28843e81..9b036d4d 100644 --- a/en/api/@connectum/testing/index/variables/MOCK_RESPONSE_HEADER.md +++ b/en/api/@connectum/testing/index/variables/MOCK_RESPONSE_HEADER.md @@ -4,6 +4,6 @@ > `const` **MOCK\_RESPONSE\_HEADER**: `"x-connectum-mock"` = `"x-connectum-mock"` -Defined in: [testing/src/mockResolver.ts:19](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/mockResolver.ts#L19) +Defined in: [testing/src/mockResolver.ts:19](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/mockResolver.ts#L19) Response header set on every mock-served response. diff --git a/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md b/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md index af07f656..01b7d0d1 100644 --- a/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md +++ b/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md @@ -4,6 +4,6 @@ > `const` **TRANSPORT\_METRIC\_ATTRIBUTE**: `"transport"` = `"transport"` -Defined in: [testing/src/otel-collectors.ts:29](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L29) +Defined in: [testing/src/otel-collectors.ts:29](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L29) Metric attribute key produced by `@connectum/otel` to distinguish transports. diff --git a/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md b/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md index 75c8f221..b29a5a28 100644 --- a/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md +++ b/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md @@ -4,6 +4,6 @@ > `const` **TRANSPORT\_SPAN\_ATTRIBUTE**: `"connectum.transport"` = `"connectum.transport"` -Defined in: [testing/src/otel-collectors.ts:27](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/otel-collectors.ts#L27) +Defined in: [testing/src/otel-collectors.ts:27](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/otel-collectors.ts#L27) Span attribute key produced by `@connectum/otel` to distinguish transports. diff --git a/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md b/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md index 7de90081..aff69fa7 100644 --- a/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md +++ b/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md @@ -2,7 +2,7 @@ # Interface: CreateTestServerOptions -Defined in: [testing/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L38) +Defined in: [testing/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L38) Options for createTestServer. @@ -12,7 +12,7 @@ Options for createTestServer. > `optional` **interceptors?**: `unknown`[] -Defined in: [testing/src/types.ts:42](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L42) +Defined in: [testing/src/types.ts:42](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L42) Interceptors to apply. Default: `[]` @@ -22,7 +22,7 @@ Interceptors to apply. Default: `[]` > `optional` **port?**: `number` -Defined in: [testing/src/types.ts:46](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L46) +Defined in: [testing/src/types.ts:46](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L46) Port number. Default: `0` (random available port) @@ -32,7 +32,7 @@ Port number. Default: `0` (random available port) > `optional` **protocols?**: `unknown`[] -Defined in: [testing/src/types.ts:44](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L44) +Defined in: [testing/src/types.ts:44](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L44) Protocol extensions (Healthcheck, Reflection). Default: `[]` @@ -42,6 +42,6 @@ Protocol extensions (Healthcheck, Reflection). Default: `[]` > **services**: `unknown`[] -Defined in: [testing/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L40) +Defined in: [testing/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L40) ConnectRPC service route handlers. diff --git a/en/api/@connectum/testing/types/interfaces/TestServer.md b/en/api/@connectum/testing/types/interfaces/TestServer.md index 0ed0facb..f13c3114 100644 --- a/en/api/@connectum/testing/types/interfaces/TestServer.md +++ b/en/api/@connectum/testing/types/interfaces/TestServer.md @@ -2,7 +2,7 @@ # Interface: TestServer -Defined in: [testing/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L26) +Defined in: [testing/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L26) A running test server with transport and cleanup. @@ -12,7 +12,7 @@ A running test server with transport and cleanup. > **baseUrl**: `string` -Defined in: [testing/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L30) +Defined in: [testing/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L30) Server base URL (e.g. `http://localhost:54321`). @@ -22,7 +22,7 @@ Server base URL (e.g. `http://localhost:54321`). > **port**: `number` -Defined in: [testing/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L32) +Defined in: [testing/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L32) Assigned port number. @@ -32,7 +32,7 @@ Assigned port number. > **transport**: `Transport` -Defined in: [testing/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L28) +Defined in: [testing/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L28) Pre-configured client transport connected to the test server. @@ -42,7 +42,7 @@ Pre-configured client transport connected to the test server. > **close**(): `Promise`\<`void`\> -Defined in: [testing/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/a01886190a74a7110bf96486238bdcb7740ecf6e/packages/testing/src/types.ts#L34) +Defined in: [testing/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/main/packages/testing/src/types.ts#L34) Stop the server and close all connections. diff --git a/en/api/typedoc-sidebar.json b/en/api/typedoc-sidebar.json index f0dc4a7d..ebf68c56 100644 --- a/en/api/typedoc-sidebar.json +++ b/en/api/typedoc-sidebar.json @@ -1 +1 @@ -[{"text":"@connectum/auth","link":"/en/api/@connectum/auth/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"proto","link":"/en/api/@connectum/auth/proto/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"AuthRequirements","link":"/en/api/@connectum/auth/proto/type-aliases/AuthRequirements.md"},{"text":"MethodAuth","link":"/en/api/@connectum/auth/proto/type-aliases/MethodAuth.md"},{"text":"ServiceAuth","link":"/en/api/@connectum/auth/proto/type-aliases/ServiceAuth.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"AuthRequirementsSchema","link":"/en/api/@connectum/auth/proto/variables/AuthRequirementsSchema.md"},{"text":"method_auth","link":"/en/api/@connectum/auth/proto/variables/method_auth.md"},{"text":"MethodAuthSchema","link":"/en/api/@connectum/auth/proto/variables/MethodAuthSchema.md"},{"text":"service_auth","link":"/en/api/@connectum/auth/proto/variables/service_auth.md"},{"text":"ServiceAuthSchema","link":"/en/api/@connectum/auth/proto/variables/ServiceAuthSchema.md"}]}]},{"text":"testing","link":"/en/api/@connectum/auth/testing/","collapsed":true,"items":[{"text":"Variables","collapsed":true,"items":[{"text":"TEST_JWT_SECRET","link":"/en/api/@connectum/auth/testing/variables/TEST_JWT_SECRET.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createMockAuthContext","link":"/en/api/@connectum/auth/testing/functions/createMockAuthContext.md"},{"text":"createTestJwt","link":"/en/api/@connectum/auth/testing/functions/createTestJwt.md"},{"text":"withAuthContext","link":"/en/api/@connectum/auth/testing/functions/withAuthContext.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"AuthzDeniedError","link":"/en/api/@connectum/auth/classes/AuthzDeniedError.md"},{"text":"LruCache","link":"/en/api/@connectum/auth/classes/LruCache.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"AuthContext","link":"/en/api/@connectum/auth/interfaces/AuthContext.md"},{"text":"AuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/AuthInterceptorOptions.md"},{"text":"AuthzDeniedDetails","link":"/en/api/@connectum/auth/interfaces/AuthzDeniedDetails.md"},{"text":"AuthzInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/AuthzInterceptorOptions.md"},{"text":"AuthzRule","link":"/en/api/@connectum/auth/interfaces/AuthzRule.md"},{"text":"CacheOptions","link":"/en/api/@connectum/auth/interfaces/CacheOptions.md"},{"text":"ClientBearerInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/ClientBearerInterceptorOptions.md"},{"text":"ClientGatewayInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/ClientGatewayInterceptorOptions.md"},{"text":"GatewayAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/GatewayAuthInterceptorOptions.md"},{"text":"GatewayHeaderMapping","link":"/en/api/@connectum/auth/interfaces/GatewayHeaderMapping.md"},{"text":"JwtAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md"},{"text":"ProtoAuthzInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md"},{"text":"ResolvedMethodAuth","link":"/en/api/@connectum/auth/interfaces/ResolvedMethodAuth.md"},{"text":"SessionAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/SessionAuthInterceptorOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AuthzEffect","link":"/en/api/@connectum/auth/type-aliases/AuthzEffect.md"},{"text":"InterceptorFactory","link":"/en/api/@connectum/auth/type-aliases/InterceptorFactory.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"AUTH_HEADERS","link":"/en/api/@connectum/auth/variables/AUTH_HEADERS.md"},{"text":"authContextStorage","link":"/en/api/@connectum/auth/variables/authContextStorage.md"},{"text":"AuthzEffect","link":"/en/api/@connectum/auth/variables/AuthzEffect.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createAuthInterceptor","link":"/en/api/@connectum/auth/functions/createAuthInterceptor.md"},{"text":"createAuthzInterceptor","link":"/en/api/@connectum/auth/functions/createAuthzInterceptor.md"},{"text":"createClientBearerInterceptor","link":"/en/api/@connectum/auth/functions/createClientBearerInterceptor.md"},{"text":"createClientGatewayInterceptor","link":"/en/api/@connectum/auth/functions/createClientGatewayInterceptor.md"},{"text":"createGatewayAuthInterceptor","link":"/en/api/@connectum/auth/functions/createGatewayAuthInterceptor.md"},{"text":"createJwtAuthInterceptor","link":"/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md"},{"text":"createProtoAuthzInterceptor","link":"/en/api/@connectum/auth/functions/createProtoAuthzInterceptor.md"},{"text":"createSessionAuthInterceptor","link":"/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md"},{"text":"getAuthContext","link":"/en/api/@connectum/auth/functions/getAuthContext.md"},{"text":"getPublicMethods","link":"/en/api/@connectum/auth/functions/getPublicMethods.md"},{"text":"matchesMethodPattern","link":"/en/api/@connectum/auth/functions/matchesMethodPattern.md"},{"text":"parseAuthHeaders","link":"/en/api/@connectum/auth/functions/parseAuthHeaders.md"},{"text":"requireAuthContext","link":"/en/api/@connectum/auth/functions/requireAuthContext.md"},{"text":"resolveMethodAuth","link":"/en/api/@connectum/auth/functions/resolveMethodAuth.md"},{"text":"setAuthHeaders","link":"/en/api/@connectum/auth/functions/setAuthHeaders.md"}]}]},{"text":"@connectum/cli","link":"/en/api/@connectum/cli/","collapsed":true,"items":[{"text":"commands","collapsed":true,"items":[{"text":"proto-sync","link":"/en/api/@connectum/cli/commands/proto-sync/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"ProtoSyncOptions","link":"/en/api/@connectum/cli/commands/proto-sync/interfaces/ProtoSyncOptions.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"protoSyncCommand","link":"/en/api/@connectum/cli/commands/proto-sync/variables/protoSyncCommand.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"executeProtoSync","link":"/en/api/@connectum/cli/commands/proto-sync/functions/executeProtoSync.md"}]}]}]},{"text":"utils","collapsed":true,"items":[{"text":"reflection","link":"/en/api/@connectum/cli/utils/reflection/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"ReflectionResult","link":"/en/api/@connectum/cli/utils/reflection/interfaces/ReflectionResult.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"fetchFileDescriptorSetBinary","link":"/en/api/@connectum/cli/utils/reflection/functions/fetchFileDescriptorSetBinary.md"},{"text":"fetchReflectionData","link":"/en/api/@connectum/cli/utils/reflection/functions/fetchReflectionData.md"}]}]}]}]},{"text":"@connectum/core","link":"/en/api/@connectum/core/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"config","link":"/en/api/@connectum/core/config/"},{"text":"types","link":"/en/api/@connectum/core/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"CreateServerOptions","link":"/en/api/@connectum/core/types/interfaces/CreateServerOptions.md"},{"text":"EventBusLike","link":"/en/api/@connectum/core/types/interfaces/EventBusLike.md"},{"text":"ProtocolContext","link":"/en/api/@connectum/core/types/interfaces/ProtocolContext.md"},{"text":"ProtocolRegistration","link":"/en/api/@connectum/core/types/interfaces/ProtocolRegistration.md"},{"text":"Server","link":"/en/api/@connectum/core/types/interfaces/Server.md"},{"text":"ServerClientOptions","link":"/en/api/@connectum/core/types/interfaces/ServerClientOptions.md"},{"text":"ShutdownOptions","link":"/en/api/@connectum/core/types/interfaces/ShutdownOptions.md"},{"text":"TLSOptions","link":"/en/api/@connectum/core/types/interfaces/TLSOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"HttpHandler","link":"/en/api/@connectum/core/types/type-aliases/HttpHandler.md"},{"text":"LifecycleEvent","link":"/en/api/@connectum/core/types/type-aliases/LifecycleEvent.md"},{"text":"NodeRequest","link":"/en/api/@connectum/core/types/type-aliases/NodeRequest.md"},{"text":"NodeResponse","link":"/en/api/@connectum/core/types/type-aliases/NodeResponse.md"},{"text":"ServerState","link":"/en/api/@connectum/core/types/type-aliases/ServerState.md"},{"text":"ShutdownHook","link":"/en/api/@connectum/core/types/type-aliases/ShutdownHook.md"},{"text":"TransportServer","link":"/en/api/@connectum/core/types/type-aliases/TransportServer.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"LifecycleEvent","link":"/en/api/@connectum/core/types/variables/LifecycleEvent.md"},{"text":"ServerState","link":"/en/api/@connectum/core/types/variables/ServerState.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"CatalogConfigError","link":"/en/api/@connectum/core/classes/CatalogConfigError.md"},{"text":"TransportValidationError","link":"/en/api/@connectum/core/classes/TransportValidationError.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BidiStreamHandle","link":"/en/api/@connectum/core/interfaces/BidiStreamHandle.md"},{"text":"ClientStreamHandle","link":"/en/api/@connectum/core/interfaces/ClientStreamHandle.md"},{"text":"ConnectumCallMap","link":"/en/api/@connectum/core/interfaces/ConnectumCallMap.md"},{"text":"ConnectumStreamMap","link":"/en/api/@connectum/core/interfaces/ConnectumStreamMap.md"},{"text":"Context","link":"/en/api/@connectum/core/interfaces/Context.md"},{"text":"CreateLocalTransportOptions","link":"/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md"},{"text":"DnsResolverOptions","link":"/en/api/@connectum/core/interfaces/DnsResolverOptions.md"},{"text":"PerServiceEnvResolverOptions","link":"/en/api/@connectum/core/interfaces/PerServiceEnvResolverOptions.md"},{"text":"ResolverContext","link":"/en/api/@connectum/core/interfaces/ResolverContext.md"},{"text":"SanitizableError","link":"/en/api/@connectum/core/interfaces/SanitizableError.md"},{"text":"ServiceDefinition","link":"/en/api/@connectum/core/interfaces/ServiceDefinition.md"},{"text":"StreamingMethodInfo","link":"/en/api/@connectum/core/interfaces/StreamingMethodInfo.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"CallOptions","link":"/en/api/@connectum/core/type-aliases/CallOptions.md"},{"text":"ConnectumEnv","link":"/en/api/@connectum/core/type-aliases/ConnectumEnv.md"},{"text":"ConnectumMethodImpl","link":"/en/api/@connectum/core/type-aliases/ConnectumMethodImpl.md"},{"text":"ConnectumServiceImpl","link":"/en/api/@connectum/core/type-aliases/ConnectumServiceImpl.md"},{"text":"EffectiveTransport","link":"/en/api/@connectum/core/type-aliases/EffectiveTransport.md"},{"text":"RemoteResolver","link":"/en/api/@connectum/core/type-aliases/RemoteResolver.md"},{"text":"ServiceCatalog","link":"/en/api/@connectum/core/type-aliases/ServiceCatalog.md"},{"text":"ServiceOptions","link":"/en/api/@connectum/core/type-aliases/ServiceOptions.md"},{"text":"StreamReturn","link":"/en/api/@connectum/core/type-aliases/StreamReturn.md"},{"text":"TransportValidationMode","link":"/en/api/@connectum/core/type-aliases/TransportValidationMode.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"BooleanFromStringSchema","link":"/en/api/@connectum/core/variables/BooleanFromStringSchema.md"},{"text":"ConnectumEnvSchema","link":"/en/api/@connectum/core/variables/ConnectumEnvSchema.md"},{"text":"defaultPropagateHeaders","link":"/en/api/@connectum/core/variables/defaultPropagateHeaders.md"},{"text":"EffectiveTransport","link":"/en/api/@connectum/core/variables/EffectiveTransport.md"},{"text":"LogFormatSchema","link":"/en/api/@connectum/core/variables/LogFormatSchema.md"},{"text":"LoggerBackendSchema","link":"/en/api/@connectum/core/variables/LoggerBackendSchema.md"},{"text":"LogLevelSchema","link":"/en/api/@connectum/core/variables/LogLevelSchema.md"},{"text":"NodeEnvSchema","link":"/en/api/@connectum/core/variables/NodeEnvSchema.md"},{"text":"tlsPath","link":"/en/api/@connectum/core/variables/tlsPath.md"},{"text":"TRANSPORT_VALIDATION_ERROR_CODE","link":"/en/api/@connectum/core/variables/TRANSPORT_VALIDATION_ERROR_CODE.md"},{"text":"TransportValidationMode","link":"/en/api/@connectum/core/variables/TransportValidationMode.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"collectStreamingMethods","link":"/en/api/@connectum/core/functions/collectStreamingMethods.md"},{"text":"createLocalTransport","link":"/en/api/@connectum/core/functions/createLocalTransport.md"},{"text":"createServer","link":"/en/api/@connectum/core/functions/createServer.md"},{"text":"defineCatalog","link":"/en/api/@connectum/core/functions/defineCatalog.md"},{"text":"defineLazyService","link":"/en/api/@connectum/core/functions/defineLazyService.md"},{"text":"defineService","link":"/en/api/@connectum/core/functions/defineService.md"},{"text":"dnsResolver","link":"/en/api/@connectum/core/functions/dnsResolver.md"},{"text":"getTLSPath","link":"/en/api/@connectum/core/functions/getTLSPath.md"},{"text":"isSanitizableError","link":"/en/api/@connectum/core/functions/isSanitizableError.md"},{"text":"mapResolver","link":"/en/api/@connectum/core/functions/mapResolver.md"},{"text":"matchServicesPattern","link":"/en/api/@connectum/core/functions/matchServicesPattern.md"},{"text":"mergeCatalogs","link":"/en/api/@connectum/core/functions/mergeCatalogs.md"},{"text":"mergeEnabledServices","link":"/en/api/@connectum/core/functions/mergeEnabledServices.md"},{"text":"parseEnvConfig","link":"/en/api/@connectum/core/functions/parseEnvConfig.md"},{"text":"parseServicesEnv","link":"/en/api/@connectum/core/functions/parseServicesEnv.md"},{"text":"perServiceEnvResolver","link":"/en/api/@connectum/core/functions/perServiceEnvResolver.md"},{"text":"readTLSCertificates","link":"/en/api/@connectum/core/functions/readTLSCertificates.md"},{"text":"resolveEffectiveTransport","link":"/en/api/@connectum/core/functions/resolveEffectiveTransport.md"},{"text":"safeParseEnvConfig","link":"/en/api/@connectum/core/functions/safeParseEnvConfig.md"},{"text":"singleTransportResolver","link":"/en/api/@connectum/core/functions/singleTransportResolver.md"}]}]},{"text":"@connectum/events","link":"/en/api/@connectum/events/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"AdapterContext","link":"/en/api/@connectum/events/types/interfaces/AdapterContext.md"},{"text":"DlqOptions","link":"/en/api/@connectum/events/types/interfaces/DlqOptions.md"},{"text":"EventAdapter","link":"/en/api/@connectum/events/types/interfaces/EventAdapter.md"},{"text":"EventBus","link":"/en/api/@connectum/events/types/interfaces/EventBus.md"},{"text":"EventBusOptions","link":"/en/api/@connectum/events/types/interfaces/EventBusOptions.md"},{"text":"EventContext","link":"/en/api/@connectum/events/types/interfaces/EventContext.md"},{"text":"EventContextInit","link":"/en/api/@connectum/events/types/interfaces/EventContextInit.md"},{"text":"EventHandlerConfig","link":"/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md"},{"text":"EventRouteEntry","link":"/en/api/@connectum/events/types/interfaces/EventRouteEntry.md"},{"text":"EventRouter","link":"/en/api/@connectum/events/types/interfaces/EventRouter.md"},{"text":"EventSubscription","link":"/en/api/@connectum/events/types/interfaces/EventSubscription.md"},{"text":"MiddlewareConfig","link":"/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md"},{"text":"PublishOptions","link":"/en/api/@connectum/events/types/interfaces/PublishOptions.md"},{"text":"RawEvent","link":"/en/api/@connectum/events/types/interfaces/RawEvent.md"},{"text":"RawSubscribeOptions","link":"/en/api/@connectum/events/types/interfaces/RawSubscribeOptions.md"},{"text":"RetryOptions","link":"/en/api/@connectum/events/types/interfaces/RetryOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"EventMiddleware","link":"/en/api/@connectum/events/types/type-aliases/EventMiddleware.md"},{"text":"EventMiddlewareNext","link":"/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md"},{"text":"EventRoute","link":"/en/api/@connectum/events/types/type-aliases/EventRoute.md"},{"text":"RawEventHandler","link":"/en/api/@connectum/events/types/type-aliases/RawEventHandler.md"},{"text":"ServiceEventHandlers","link":"/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md"},{"text":"TypedEventHandler","link":"/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"EventRouterImpl","link":"/en/api/@connectum/events/classes/EventRouterImpl.md"},{"text":"NonRetryableError","link":"/en/api/@connectum/events/classes/NonRetryableError.md"},{"text":"RetryableError","link":"/en/api/@connectum/events/classes/RetryableError.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"composeMiddleware","link":"/en/api/@connectum/events/functions/composeMiddleware.md"},{"text":"createEventBus","link":"/en/api/@connectum/events/functions/createEventBus.md"},{"text":"createEventContext","link":"/en/api/@connectum/events/functions/createEventContext.md"},{"text":"deriveServiceName","link":"/en/api/@connectum/events/functions/deriveServiceName.md"},{"text":"dlqMiddleware","link":"/en/api/@connectum/events/functions/dlqMiddleware.md"},{"text":"matchPattern","link":"/en/api/@connectum/events/functions/matchPattern.md"},{"text":"MemoryAdapter","link":"/en/api/@connectum/events/functions/MemoryAdapter.md"},{"text":"resolveTopicName","link":"/en/api/@connectum/events/functions/resolveTopicName.md"},{"text":"retryMiddleware","link":"/en/api/@connectum/events/functions/retryMiddleware.md"}]}]},{"text":"@connectum/events-amqp","link":"/en/api/@connectum/events-amqp/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-amqp/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"AmqpAdapterOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md"},{"text":"AmqpBindingDeclaration","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md"},{"text":"AmqpConsumerOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md"},{"text":"AmqpExchangeDeclaration","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md"},{"text":"AmqpExchangeOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md"},{"text":"AmqpLifecycleCallbacks","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md"},{"text":"AmqpPublisherOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md"},{"text":"AmqpQueueDeclaration","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md"},{"text":"AmqpQueueOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md"},{"text":"AmqpQueueOverride","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOverride.md"},{"text":"AmqpRecoveryOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpRecoveryOptions.md"},{"text":"AmqpSerializationOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpSerializationOptions.md"},{"text":"AmqpTopology","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpTopology.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AmqpTopologyMode","link":"/en/api/@connectum/events-amqp/types/type-aliases/AmqpTopologyMode.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"AmqpTopologyMode","link":"/en/api/@connectum/events-amqp/types/variables/AmqpTopologyMode.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"AmqpAdapterError","link":"/en/api/@connectum/events-amqp/classes/AmqpAdapterError.md"},{"text":"AmqpConnectionError","link":"/en/api/@connectum/events-amqp/classes/AmqpConnectionError.md"},{"text":"AmqpPublishNackError","link":"/en/api/@connectum/events-amqp/classes/AmqpPublishNackError.md"},{"text":"AmqpPublishTimeoutError","link":"/en/api/@connectum/events-amqp/classes/AmqpPublishTimeoutError.md"},{"text":"AmqpSerializationError","link":"/en/api/@connectum/events-amqp/classes/AmqpSerializationError.md"},{"text":"AmqpTopologyError","link":"/en/api/@connectum/events-amqp/classes/AmqpTopologyError.md"},{"text":"AmqpUnroutableError","link":"/en/api/@connectum/events-amqp/classes/AmqpUnroutableError.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"AmqpAdapter","link":"/en/api/@connectum/events-amqp/functions/AmqpAdapter.md"},{"text":"toAmqpPattern","link":"/en/api/@connectum/events-amqp/functions/toAmqpPattern.md"}]}]},{"text":"@connectum/events-kafka","link":"/en/api/@connectum/events-kafka/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-kafka/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"KafkaAdapterOptions","link":"/en/api/@connectum/events-kafka/types/interfaces/KafkaAdapterOptions.md"}]}]}]},{"text":"Functions","collapsed":true,"items":[{"text":"KafkaAdapter","link":"/en/api/@connectum/events-kafka/functions/KafkaAdapter.md"}]}]},{"text":"@connectum/events-nats","link":"/en/api/@connectum/events-nats/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-nats/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"NatsAdapterOptions","link":"/en/api/@connectum/events-nats/types/interfaces/NatsAdapterOptions.md"},{"text":"NatsConsumerOptions","link":"/en/api/@connectum/events-nats/types/interfaces/NatsConsumerOptions.md"}]}]}]},{"text":"Functions","collapsed":true,"items":[{"text":"NatsAdapter","link":"/en/api/@connectum/events-nats/functions/NatsAdapter.md"}]}]},{"text":"@connectum/events-redis","link":"/en/api/@connectum/events-redis/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-redis/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"RedisAdapterOptions","link":"/en/api/@connectum/events-redis/types/interfaces/RedisAdapterOptions.md"},{"text":"RedisBrokerOptions","link":"/en/api/@connectum/events-redis/types/interfaces/RedisBrokerOptions.md"}]}]}]},{"text":"Functions","collapsed":true,"items":[{"text":"RedisAdapter","link":"/en/api/@connectum/events-redis/functions/RedisAdapter.md"}]}]},{"text":"@connectum/healthcheck","link":"/en/api/@connectum/healthcheck/","collapsed":true,"items":[{"text":"@connectum/healthcheck","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"HealthcheckManager","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/classes/HealthcheckManager.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"healthcheckManager","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/variables/healthcheckManager.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createHealthcheckManager","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHealthcheckManager.md"},{"text":"createHttpHealthHandler","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHttpHealthHandler.md"},{"text":"Healthcheck","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/Healthcheck.md"},{"text":"parseServiceFromUrl","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/parseServiceFromUrl.md"}]}]},{"text":"@connectum/healthcheck/types","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"HealthcheckOptions","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/HealthcheckOptions.md"},{"text":"ServiceStatus","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/ServiceStatus.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"ServingStatus","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/type-aliases/ServingStatus.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"ServingStatus","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/variables/ServingStatus.md"}]}]}]},{"text":"@connectum/interceptors","link":"/en/api/@connectum/interceptors/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"bulkhead","link":"/en/api/@connectum/interceptors/bulkhead/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createBulkheadInterceptor","link":"/en/api/@connectum/interceptors/bulkhead/functions/createBulkheadInterceptor.md"}]}]},{"text":"circuit-breaker","link":"/en/api/@connectum/interceptors/circuit-breaker/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createCircuitBreakerInterceptor","link":"/en/api/@connectum/interceptors/circuit-breaker/functions/createCircuitBreakerInterceptor.md"},{"text":"defaultFailurePredicate","link":"/en/api/@connectum/interceptors/circuit-breaker/functions/defaultFailurePredicate.md"}]}]},{"text":"defaults","link":"/en/api/@connectum/interceptors/defaults/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"DefaultInterceptorOptions","link":"/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createDefaultInterceptors","link":"/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md"}]}]},{"text":"errorHandler","link":"/en/api/@connectum/interceptors/errorHandler/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createErrorHandlerInterceptor","link":"/en/api/@connectum/interceptors/errorHandler/functions/createErrorHandlerInterceptor.md"}]}]},{"text":"fallback","link":"/en/api/@connectum/interceptors/fallback/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createFallbackInterceptor","link":"/en/api/@connectum/interceptors/fallback/functions/createFallbackInterceptor.md"}]}]},{"text":"logger","link":"/en/api/@connectum/interceptors/logger/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createLoggerInterceptor","link":"/en/api/@connectum/interceptors/logger/functions/createLoggerInterceptor.md"}]}]},{"text":"method-filter","link":"/en/api/@connectum/interceptors/method-filter/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createMethodFilterInterceptor","link":"/en/api/@connectum/interceptors/method-filter/functions/createMethodFilterInterceptor.md"}]}]},{"text":"retry","link":"/en/api/@connectum/interceptors/retry/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createRetryInterceptor","link":"/en/api/@connectum/interceptors/retry/functions/createRetryInterceptor.md"}]}]},{"text":"serializer","link":"/en/api/@connectum/interceptors/serializer/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createSerializerInterceptor","link":"/en/api/@connectum/interceptors/serializer/functions/createSerializerInterceptor.md"}]}]},{"text":"timeout","link":"/en/api/@connectum/interceptors/timeout/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createTimeoutInterceptor","link":"/en/api/@connectum/interceptors/timeout/functions/createTimeoutInterceptor.md"}]}]}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BulkheadOptions","link":"/en/api/@connectum/interceptors/interfaces/BulkheadOptions.md"},{"text":"CircuitBreakerOptions","link":"/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md"},{"text":"ErrorHandlerOptions","link":"/en/api/@connectum/interceptors/interfaces/ErrorHandlerOptions.md"},{"text":"FallbackOptions","link":"/en/api/@connectum/interceptors/interfaces/FallbackOptions.md"},{"text":"LoggerOptions","link":"/en/api/@connectum/interceptors/interfaces/LoggerOptions.md"},{"text":"RetryOptions","link":"/en/api/@connectum/interceptors/interfaces/RetryOptions.md"},{"text":"SerializerOptions","link":"/en/api/@connectum/interceptors/interfaces/SerializerOptions.md"},{"text":"TimeoutOptions","link":"/en/api/@connectum/interceptors/interfaces/TimeoutOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"InterceptorFactory","link":"/en/api/@connectum/interceptors/type-aliases/InterceptorFactory.md"},{"text":"MethodFilterMap","link":"/en/api/@connectum/interceptors/type-aliases/MethodFilterMap.md"}]}]},{"text":"@connectum/otel","link":"/en/api/@connectum/otel/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"attributes","link":"/en/api/@connectum/otel/attributes/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"ConnectErrorCode","link":"/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"ATTR_CONNECTUM_TRANSPORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md"},{"text":"ATTR_CONNECTUM_TRANSPORT_METRIC","link":"/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md"},{"text":"ATTR_ERROR_TYPE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_ERROR_TYPE.md"},{"text":"ATTR_NETWORK_PEER_ADDRESS","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_ADDRESS.md"},{"text":"ATTR_NETWORK_PEER_PORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_PORT.md"},{"text":"ATTR_NETWORK_PROTOCOL_NAME","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PROTOCOL_NAME.md"},{"text":"ATTR_NETWORK_TRANSPORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_TRANSPORT.md"},{"text":"ATTR_RPC_CONNECT_RPC_STATUS_CODE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_CONNECT_RPC_STATUS_CODE.md"},{"text":"ATTR_RPC_MESSAGE_ID","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_ID.md"},{"text":"ATTR_RPC_MESSAGE_TYPE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_TYPE.md"},{"text":"ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md"},{"text":"ATTR_RPC_METHOD","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_METHOD.md"},{"text":"ATTR_RPC_SERVICE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SERVICE.md"},{"text":"ATTR_RPC_SYSTEM","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SYSTEM.md"},{"text":"ATTR_SERVER_ADDRESS","link":"/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_ADDRESS.md"},{"text":"ATTR_SERVER_PORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_PORT.md"},{"text":"ConnectErrorCode","link":"/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md"},{"text":"ConnectErrorCodeName","link":"/en/api/@connectum/otel/attributes/variables/ConnectErrorCodeName.md"},{"text":"CONNECTUM_INTERNAL_TRANSPORT_HEADER","link":"/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md"},{"text":"CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS","link":"/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md"},{"text":"RPC_MESSAGE_EVENT","link":"/en/api/@connectum/otel/attributes/variables/RPC_MESSAGE_EVENT.md"},{"text":"RPC_SYSTEM_CONNECT_RPC","link":"/en/api/@connectum/otel/attributes/variables/RPC_SYSTEM_CONNECT_RPC.md"}]}]},{"text":"client-interceptor","link":"/en/api/@connectum/otel/client-interceptor/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createOtelClientInterceptor","link":"/en/api/@connectum/otel/client-interceptor/functions/createOtelClientInterceptor.md"}]}]},{"text":"interceptor","link":"/en/api/@connectum/otel/interceptor/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createOtelInterceptor","link":"/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md"}]}]},{"text":"logger","link":"/en/api/@connectum/otel/logger/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"Logger","link":"/en/api/@connectum/otel/logger/interfaces/Logger.md"},{"text":"LoggerOptions","link":"/en/api/@connectum/otel/logger/interfaces/LoggerOptions.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"getLogger","link":"/en/api/@connectum/otel/logger/functions/getLogger.md"}]}]},{"text":"meter","link":"/en/api/@connectum/otel/meter/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"getMeter","link":"/en/api/@connectum/otel/meter/functions/getMeter.md"}]}]},{"text":"metrics","link":"/en/api/@connectum/otel/metrics/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"RpcClientMetrics","link":"/en/api/@connectum/otel/metrics/interfaces/RpcClientMetrics.md"},{"text":"RpcServerMetrics","link":"/en/api/@connectum/otel/metrics/interfaces/RpcServerMetrics.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createRpcClientMetrics","link":"/en/api/@connectum/otel/metrics/functions/createRpcClientMetrics.md"},{"text":"createRpcServerMetrics","link":"/en/api/@connectum/otel/metrics/functions/createRpcServerMetrics.md"}]}]},{"text":"provider","link":"/en/api/@connectum/otel/provider/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"ProviderOptions","link":"/en/api/@connectum/otel/provider/interfaces/ProviderOptions.md"},{"text":"ResourceAttributeInputs","link":"/en/api/@connectum/otel/provider/interfaces/ResourceAttributeInputs.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildResourceAttributes","link":"/en/api/@connectum/otel/provider/functions/buildResourceAttributes.md"},{"text":"getProvider","link":"/en/api/@connectum/otel/provider/functions/getProvider.md"},{"text":"initProvider","link":"/en/api/@connectum/otel/provider/functions/initProvider.md"},{"text":"parseOtelResourceAttributesEnv","link":"/en/api/@connectum/otel/provider/functions/parseOtelResourceAttributesEnv.md"},{"text":"shutdownProvider","link":"/en/api/@connectum/otel/provider/functions/shutdownProvider.md"}]}]},{"text":"shared","link":"/en/api/@connectum/otel/shared/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"BaseAttributeParams","link":"/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"applyAttributeFilter","link":"/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md"},{"text":"buildBaseAttributes","link":"/en/api/@connectum/otel/shared/functions/buildBaseAttributes.md"},{"text":"buildErrorAttributes","link":"/en/api/@connectum/otel/shared/functions/buildErrorAttributes.md"},{"text":"detectConnectumTransport","link":"/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md"},{"text":"estimateMessageSize","link":"/en/api/@connectum/otel/shared/functions/estimateMessageSize.md"},{"text":"wrapAsyncIterable","link":"/en/api/@connectum/otel/shared/functions/wrapAsyncIterable.md"}]}]},{"text":"traceAll","link":"/en/api/@connectum/otel/traceAll/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"traceAll","link":"/en/api/@connectum/otel/traceAll/functions/traceAll.md"}]}]},{"text":"traced","link":"/en/api/@connectum/otel/traced/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"traced","link":"/en/api/@connectum/otel/traced/functions/traced.md"}]}]},{"text":"tracer","link":"/en/api/@connectum/otel/tracer/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"getTracer","link":"/en/api/@connectum/otel/tracer/functions/getTracer.md"}]}]}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BatchSpanProcessorOptions","link":"/en/api/@connectum/otel/interfaces/BatchSpanProcessorOptions.md"},{"text":"CollectorOptions","link":"/en/api/@connectum/otel/interfaces/CollectorOptions.md"},{"text":"Meter","link":"/en/api/@connectum/otel/interfaces/Meter.md"},{"text":"OtelBaseOptions","link":"/en/api/@connectum/otel/interfaces/OtelBaseOptions.md"},{"text":"OtelClientInterceptorOptions","link":"/en/api/@connectum/otel/interfaces/OtelClientInterceptorOptions.md"},{"text":"OtelInterceptorOptions","link":"/en/api/@connectum/otel/interfaces/OtelInterceptorOptions.md"},{"text":"OTLPSettings","link":"/en/api/@connectum/otel/interfaces/OTLPSettings.md"},{"text":"TraceAllOptions","link":"/en/api/@connectum/otel/interfaces/TraceAllOptions.md"},{"text":"TracedOptions","link":"/en/api/@connectum/otel/interfaces/TracedOptions.md"},{"text":"Tracer","link":"/en/api/@connectum/otel/interfaces/Tracer.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"ArgsFilter","link":"/en/api/@connectum/otel/type-aliases/ArgsFilter.md"},{"text":"ExporterType","link":"/en/api/@connectum/otel/type-aliases/ExporterType.md"},{"text":"MethodArgsFilter","link":"/en/api/@connectum/otel/type-aliases/MethodArgsFilter.md"},{"text":"OtelAttributeFilter","link":"/en/api/@connectum/otel/type-aliases/OtelAttributeFilter.md"},{"text":"OtelFilter","link":"/en/api/@connectum/otel/type-aliases/OtelFilter.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"ExporterType","link":"/en/api/@connectum/otel/variables/ExporterType.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"getBatchSpanProcessorOptions","link":"/en/api/@connectum/otel/functions/getBatchSpanProcessorOptions.md"},{"text":"getCollectorOptions","link":"/en/api/@connectum/otel/functions/getCollectorOptions.md"},{"text":"getOTLPSettings","link":"/en/api/@connectum/otel/functions/getOTLPSettings.md"},{"text":"getServiceMetadata","link":"/en/api/@connectum/otel/functions/getServiceMetadata.md"}]}]},{"text":"@connectum/reflection","link":"/en/api/@connectum/reflection/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"collectFileProtos","link":"/en/api/@connectum/reflection/functions/collectFileProtos.md"},{"text":"Reflection","link":"/en/api/@connectum/reflection/functions/Reflection.md"}]}]},{"text":"@connectum/test-fixtures","link":"/en/api/@connectum/test-fixtures/","collapsed":true,"items":[{"text":"index","link":"/en/api/@connectum/test-fixtures/index/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"MockCall","link":"/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md"},{"text":"MockFn","link":"/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"assertConnectError","link":"/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md"},{"text":"createFakeMethod","link":"/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md"},{"text":"createFakeService","link":"/en/api/@connectum/test-fixtures/index/functions/createFakeService.md"},{"text":"createMockDescField","link":"/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md"},{"text":"createMockDescMessage","link":"/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md"},{"text":"createMockDescMethod","link":"/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md"},{"text":"createMockFn","link":"/en/api/@connectum/test-fixtures/index/functions/createMockFn.md"},{"text":"createMockNext","link":"/en/api/@connectum/test-fixtures/index/functions/createMockNext.md"},{"text":"createMockNextError","link":"/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md"},{"text":"createMockNextSlow","link":"/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md"},{"text":"createMockRequest","link":"/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md"},{"text":"createMockStream","link":"/en/api/@connectum/test-fixtures/index/functions/createMockStream.md"}]}]},{"text":"types","link":"/en/api/@connectum/test-fixtures/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"FakeMethodOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md"},{"text":"FakeServiceOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md"},{"text":"MockDescFieldOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md"},{"text":"MockDescMessageOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md"},{"text":"MockDescMethodOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md"},{"text":"MockNextOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md"},{"text":"MockRequestOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md"},{"text":"MockStreamOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md"}]}]}]},{"text":"@connectum/testing","link":"/en/api/@connectum/testing/","collapsed":true,"items":[{"text":"index","link":"/en/api/@connectum/testing/index/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"InMemoryMetricCollector","link":"/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md"},{"text":"InMemorySpanCollector","link":"/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CreateMockContextOptions","link":"/en/api/@connectum/testing/index/interfaces/CreateMockContextOptions.md"},{"text":"FakeMethodOptions","link":"/en/api/@connectum/testing/index/interfaces/FakeMethodOptions.md"},{"text":"FakeServiceOptions","link":"/en/api/@connectum/testing/index/interfaces/FakeServiceOptions.md"},{"text":"MockCall","link":"/en/api/@connectum/testing/index/interfaces/MockCall.md"},{"text":"MockDescFieldOptions","link":"/en/api/@connectum/testing/index/interfaces/MockDescFieldOptions.md"},{"text":"MockDescMessageOptions","link":"/en/api/@connectum/testing/index/interfaces/MockDescMessageOptions.md"},{"text":"MockDescMethodOptions","link":"/en/api/@connectum/testing/index/interfaces/MockDescMethodOptions.md"},{"text":"MockFn","link":"/en/api/@connectum/testing/index/interfaces/MockFn.md"},{"text":"MockNextOptions","link":"/en/api/@connectum/testing/index/interfaces/MockNextOptions.md"},{"text":"MockRequestOptions","link":"/en/api/@connectum/testing/index/interfaces/MockRequestOptions.md"},{"text":"MockService","link":"/en/api/@connectum/testing/index/interfaces/MockService.md"},{"text":"MockStreamOptions","link":"/en/api/@connectum/testing/index/interfaces/MockStreamOptions.md"},{"text":"NormalizedMetric","link":"/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md"},{"text":"NormalizedSpan","link":"/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"MOCK_RESPONSE_HEADER","link":"/en/api/@connectum/testing/index/variables/MOCK_RESPONSE_HEADER.md"},{"text":"TRANSPORT_METRIC_ATTRIBUTE","link":"/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md"},{"text":"TRANSPORT_SPAN_ATTRIBUTE","link":"/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"assertConnectError","link":"/en/api/@connectum/testing/index/functions/assertConnectError.md"},{"text":"createFakeMethod","link":"/en/api/@connectum/testing/index/functions/createFakeMethod.md"},{"text":"createFakeService","link":"/en/api/@connectum/testing/index/functions/createFakeService.md"},{"text":"createLocalClient","link":"/en/api/@connectum/testing/index/functions/createLocalClient.md"},{"text":"createMockContext","link":"/en/api/@connectum/testing/index/functions/createMockContext.md"},{"text":"createMockDescField","link":"/en/api/@connectum/testing/index/functions/createMockDescField.md"},{"text":"createMockDescMessage","link":"/en/api/@connectum/testing/index/functions/createMockDescMessage.md"},{"text":"createMockDescMethod","link":"/en/api/@connectum/testing/index/functions/createMockDescMethod.md"},{"text":"createMockFn","link":"/en/api/@connectum/testing/index/functions/createMockFn.md"},{"text":"createMockNext","link":"/en/api/@connectum/testing/index/functions/createMockNext.md"},{"text":"createMockNextError","link":"/en/api/@connectum/testing/index/functions/createMockNextError.md"},{"text":"createMockNextSlow","link":"/en/api/@connectum/testing/index/functions/createMockNextSlow.md"},{"text":"createMockRequest","link":"/en/api/@connectum/testing/index/functions/createMockRequest.md"},{"text":"createMockStream","link":"/en/api/@connectum/testing/index/functions/createMockStream.md"},{"text":"createTestServer","link":"/en/api/@connectum/testing/index/functions/createTestServer.md"},{"text":"mockResolver","link":"/en/api/@connectum/testing/index/functions/mockResolver.md"},{"text":"mockService","link":"/en/api/@connectum/testing/index/functions/mockService.md"},{"text":"withTestServer","link":"/en/api/@connectum/testing/index/functions/withTestServer.md"}]}]},{"text":"types","link":"/en/api/@connectum/testing/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"CreateTestServerOptions","link":"/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md"},{"text":"TestServer","link":"/en/api/@connectum/testing/types/interfaces/TestServer.md"}]}]}]}] \ No newline at end of file +[{"text":"@connectum/auth","link":"/en/api/@connectum/auth/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"proto","link":"/en/api/@connectum/auth/proto/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"AuthRequirements","link":"/en/api/@connectum/auth/proto/type-aliases/AuthRequirements.md"},{"text":"MethodAuth","link":"/en/api/@connectum/auth/proto/type-aliases/MethodAuth.md"},{"text":"ServiceAuth","link":"/en/api/@connectum/auth/proto/type-aliases/ServiceAuth.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"AuthRequirementsSchema","link":"/en/api/@connectum/auth/proto/variables/AuthRequirementsSchema.md"},{"text":"method_auth","link":"/en/api/@connectum/auth/proto/variables/method_auth.md"},{"text":"MethodAuthSchema","link":"/en/api/@connectum/auth/proto/variables/MethodAuthSchema.md"},{"text":"service_auth","link":"/en/api/@connectum/auth/proto/variables/service_auth.md"},{"text":"ServiceAuthSchema","link":"/en/api/@connectum/auth/proto/variables/ServiceAuthSchema.md"}]}]},{"text":"testing","link":"/en/api/@connectum/auth/testing/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"RsaTestKeypair","link":"/en/api/@connectum/auth/testing/interfaces/RsaTestKeypair.md"},{"text":"TestJwksServer","link":"/en/api/@connectum/auth/testing/interfaces/TestJwksServer.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"TEST_JWT_KID","link":"/en/api/@connectum/auth/testing/variables/TEST_JWT_KID.md"},{"text":"TEST_JWT_SECRET","link":"/en/api/@connectum/auth/testing/variables/TEST_JWT_SECRET.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createMockAuthContext","link":"/en/api/@connectum/auth/testing/functions/createMockAuthContext.md"},{"text":"createTestJwt","link":"/en/api/@connectum/auth/testing/functions/createTestJwt.md"},{"text":"createTestJwtRS256","link":"/en/api/@connectum/auth/testing/functions/createTestJwtRS256.md"},{"text":"generateRsaTestKeypair","link":"/en/api/@connectum/auth/testing/functions/generateRsaTestKeypair.md"},{"text":"startTestJwksServer","link":"/en/api/@connectum/auth/testing/functions/startTestJwksServer.md"},{"text":"withAuthContext","link":"/en/api/@connectum/auth/testing/functions/withAuthContext.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"AuthzDeniedError","link":"/en/api/@connectum/auth/classes/AuthzDeniedError.md"},{"text":"LruCache","link":"/en/api/@connectum/auth/classes/LruCache.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"AuthContext","link":"/en/api/@connectum/auth/interfaces/AuthContext.md"},{"text":"AuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/AuthInterceptorOptions.md"},{"text":"AuthzDeniedDetails","link":"/en/api/@connectum/auth/interfaces/AuthzDeniedDetails.md"},{"text":"AuthzInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/AuthzInterceptorOptions.md"},{"text":"AuthzRule","link":"/en/api/@connectum/auth/interfaces/AuthzRule.md"},{"text":"CacheOptions","link":"/en/api/@connectum/auth/interfaces/CacheOptions.md"},{"text":"ClientBearerInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/ClientBearerInterceptorOptions.md"},{"text":"ClientGatewayInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/ClientGatewayInterceptorOptions.md"},{"text":"GatewayAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/GatewayAuthInterceptorOptions.md"},{"text":"GatewayHeaderMapping","link":"/en/api/@connectum/auth/interfaces/GatewayHeaderMapping.md"},{"text":"InternalAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/InternalAuthInterceptorOptions.md"},{"text":"JwtAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md"},{"text":"MeshIdentityEntry","link":"/en/api/@connectum/auth/interfaces/MeshIdentityEntry.md"},{"text":"MeshIdentityTrustOptions","link":"/en/api/@connectum/auth/interfaces/MeshIdentityTrustOptions.md"},{"text":"ProtoAuthzInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md"},{"text":"ResolvedMethodAuth","link":"/en/api/@connectum/auth/interfaces/ResolvedMethodAuth.md"},{"text":"SessionAuthInterceptorOptions","link":"/en/api/@connectum/auth/interfaces/SessionAuthInterceptorOptions.md"},{"text":"SharedSecretTrustOptions","link":"/en/api/@connectum/auth/interfaces/SharedSecretTrustOptions.md"},{"text":"SignedTokenIssuer","link":"/en/api/@connectum/auth/interfaces/SignedTokenIssuer.md"},{"text":"SignedTokenTrustOptions","link":"/en/api/@connectum/auth/interfaces/SignedTokenTrustOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AuthzEffect","link":"/en/api/@connectum/auth/type-aliases/AuthzEffect.md"},{"text":"InterceptorFactory","link":"/en/api/@connectum/auth/type-aliases/InterceptorFactory.md"},{"text":"InternalTrustSource","link":"/en/api/@connectum/auth/type-aliases/InternalTrustSource.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"AUTH_HEADERS","link":"/en/api/@connectum/auth/variables/AUTH_HEADERS.md"},{"text":"authContextStorage","link":"/en/api/@connectum/auth/variables/authContextStorage.md"},{"text":"AuthzEffect","link":"/en/api/@connectum/auth/variables/AuthzEffect.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createAuthInterceptor","link":"/en/api/@connectum/auth/functions/createAuthInterceptor.md"},{"text":"createAuthzInterceptor","link":"/en/api/@connectum/auth/functions/createAuthzInterceptor.md"},{"text":"createClientBearerInterceptor","link":"/en/api/@connectum/auth/functions/createClientBearerInterceptor.md"},{"text":"createClientGatewayInterceptor","link":"/en/api/@connectum/auth/functions/createClientGatewayInterceptor.md"},{"text":"createGatewayAuthInterceptor","link":"/en/api/@connectum/auth/functions/createGatewayAuthInterceptor.md"},{"text":"createInternalAuthInterceptor","link":"/en/api/@connectum/auth/functions/createInternalAuthInterceptor.md"},{"text":"createJwtAuthInterceptor","link":"/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md"},{"text":"createProtoAuthzInterceptor","link":"/en/api/@connectum/auth/functions/createProtoAuthzInterceptor.md"},{"text":"createSessionAuthInterceptor","link":"/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md"},{"text":"getAuthContext","link":"/en/api/@connectum/auth/functions/getAuthContext.md"},{"text":"getInternalMethods","link":"/en/api/@connectum/auth/functions/getInternalMethods.md"},{"text":"getPublicMethods","link":"/en/api/@connectum/auth/functions/getPublicMethods.md"},{"text":"matchesMethodPattern","link":"/en/api/@connectum/auth/functions/matchesMethodPattern.md"},{"text":"meshIdentityTrust","link":"/en/api/@connectum/auth/functions/meshIdentityTrust.md"},{"text":"parseAuthHeaders","link":"/en/api/@connectum/auth/functions/parseAuthHeaders.md"},{"text":"requireAuthContext","link":"/en/api/@connectum/auth/functions/requireAuthContext.md"},{"text":"resolveMethodAuth","link":"/en/api/@connectum/auth/functions/resolveMethodAuth.md"},{"text":"setAuthHeaders","link":"/en/api/@connectum/auth/functions/setAuthHeaders.md"},{"text":"sharedSecretTrust","link":"/en/api/@connectum/auth/functions/sharedSecretTrust.md"},{"text":"signedTokenTrust","link":"/en/api/@connectum/auth/functions/signedTokenTrust.md"}]}]},{"text":"@connectum/cli","link":"/en/api/@connectum/cli/","collapsed":true,"items":[{"text":"commands","collapsed":true,"items":[{"text":"proto-sync","link":"/en/api/@connectum/cli/commands/proto-sync/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"ProtoSyncOptions","link":"/en/api/@connectum/cli/commands/proto-sync/interfaces/ProtoSyncOptions.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"protoSyncCommand","link":"/en/api/@connectum/cli/commands/proto-sync/variables/protoSyncCommand.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"executeProtoSync","link":"/en/api/@connectum/cli/commands/proto-sync/functions/executeProtoSync.md"}]}]}]},{"text":"utils","collapsed":true,"items":[{"text":"reflection","link":"/en/api/@connectum/cli/utils/reflection/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"ReflectionResult","link":"/en/api/@connectum/cli/utils/reflection/interfaces/ReflectionResult.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"fetchFileDescriptorSetBinary","link":"/en/api/@connectum/cli/utils/reflection/functions/fetchFileDescriptorSetBinary.md"},{"text":"fetchReflectionData","link":"/en/api/@connectum/cli/utils/reflection/functions/fetchReflectionData.md"}]}]}]}]},{"text":"@connectum/core","link":"/en/api/@connectum/core/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"config","link":"/en/api/@connectum/core/config/"},{"text":"types","link":"/en/api/@connectum/core/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"CreateServerOptions","link":"/en/api/@connectum/core/types/interfaces/CreateServerOptions.md"},{"text":"EventBusLike","link":"/en/api/@connectum/core/types/interfaces/EventBusLike.md"},{"text":"ProtocolContext","link":"/en/api/@connectum/core/types/interfaces/ProtocolContext.md"},{"text":"ProtocolRegistration","link":"/en/api/@connectum/core/types/interfaces/ProtocolRegistration.md"},{"text":"Server","link":"/en/api/@connectum/core/types/interfaces/Server.md"},{"text":"ServerClientOptions","link":"/en/api/@connectum/core/types/interfaces/ServerClientOptions.md"},{"text":"ShutdownOptions","link":"/en/api/@connectum/core/types/interfaces/ShutdownOptions.md"},{"text":"TLSOptions","link":"/en/api/@connectum/core/types/interfaces/TLSOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"HttpHandler","link":"/en/api/@connectum/core/types/type-aliases/HttpHandler.md"},{"text":"LifecycleEvent","link":"/en/api/@connectum/core/types/type-aliases/LifecycleEvent.md"},{"text":"NodeRequest","link":"/en/api/@connectum/core/types/type-aliases/NodeRequest.md"},{"text":"NodeResponse","link":"/en/api/@connectum/core/types/type-aliases/NodeResponse.md"},{"text":"ServerState","link":"/en/api/@connectum/core/types/type-aliases/ServerState.md"},{"text":"ShutdownHook","link":"/en/api/@connectum/core/types/type-aliases/ShutdownHook.md"},{"text":"TransportServer","link":"/en/api/@connectum/core/types/type-aliases/TransportServer.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"LifecycleEvent","link":"/en/api/@connectum/core/types/variables/LifecycleEvent.md"},{"text":"ServerState","link":"/en/api/@connectum/core/types/variables/ServerState.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"CatalogConfigError","link":"/en/api/@connectum/core/classes/CatalogConfigError.md"},{"text":"TransportValidationError","link":"/en/api/@connectum/core/classes/TransportValidationError.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BidiStreamHandle","link":"/en/api/@connectum/core/interfaces/BidiStreamHandle.md"},{"text":"CatalogClient","link":"/en/api/@connectum/core/interfaces/CatalogClient.md"},{"text":"ClientStreamHandle","link":"/en/api/@connectum/core/interfaces/ClientStreamHandle.md"},{"text":"ConnectumCallMap","link":"/en/api/@connectum/core/interfaces/ConnectumCallMap.md"},{"text":"ConnectumStreamMap","link":"/en/api/@connectum/core/interfaces/ConnectumStreamMap.md"},{"text":"Context","link":"/en/api/@connectum/core/interfaces/Context.md"},{"text":"CreateCatalogClientOptions","link":"/en/api/@connectum/core/interfaces/CreateCatalogClientOptions.md"},{"text":"CreateLocalTransportOptions","link":"/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md"},{"text":"DnsResolverOptions","link":"/en/api/@connectum/core/interfaces/DnsResolverOptions.md"},{"text":"PerServiceEnvResolverOptions","link":"/en/api/@connectum/core/interfaces/PerServiceEnvResolverOptions.md"},{"text":"ResolverContext","link":"/en/api/@connectum/core/interfaces/ResolverContext.md"},{"text":"SanitizableError","link":"/en/api/@connectum/core/interfaces/SanitizableError.md"},{"text":"ServiceDefinition","link":"/en/api/@connectum/core/interfaces/ServiceDefinition.md"},{"text":"StreamingMethodInfo","link":"/en/api/@connectum/core/interfaces/StreamingMethodInfo.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"CallOptions","link":"/en/api/@connectum/core/type-aliases/CallOptions.md"},{"text":"CatalogCall","link":"/en/api/@connectum/core/type-aliases/CatalogCall.md"},{"text":"CatalogStream","link":"/en/api/@connectum/core/type-aliases/CatalogStream.md"},{"text":"ConnectumEnv","link":"/en/api/@connectum/core/type-aliases/ConnectumEnv.md"},{"text":"ConnectumMethodImpl","link":"/en/api/@connectum/core/type-aliases/ConnectumMethodImpl.md"},{"text":"ConnectumServiceImpl","link":"/en/api/@connectum/core/type-aliases/ConnectumServiceImpl.md"},{"text":"EffectiveTransport","link":"/en/api/@connectum/core/type-aliases/EffectiveTransport.md"},{"text":"RemoteResolver","link":"/en/api/@connectum/core/type-aliases/RemoteResolver.md"},{"text":"ServiceCatalog","link":"/en/api/@connectum/core/type-aliases/ServiceCatalog.md"},{"text":"ServiceOptions","link":"/en/api/@connectum/core/type-aliases/ServiceOptions.md"},{"text":"StreamReturn","link":"/en/api/@connectum/core/type-aliases/StreamReturn.md"},{"text":"TransportValidationMode","link":"/en/api/@connectum/core/type-aliases/TransportValidationMode.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"BooleanFromStringSchema","link":"/en/api/@connectum/core/variables/BooleanFromStringSchema.md"},{"text":"ConnectumEnvSchema","link":"/en/api/@connectum/core/variables/ConnectumEnvSchema.md"},{"text":"defaultPropagateHeaders","link":"/en/api/@connectum/core/variables/defaultPropagateHeaders.md"},{"text":"EffectiveTransport","link":"/en/api/@connectum/core/variables/EffectiveTransport.md"},{"text":"LogFormatSchema","link":"/en/api/@connectum/core/variables/LogFormatSchema.md"},{"text":"LoggerBackendSchema","link":"/en/api/@connectum/core/variables/LoggerBackendSchema.md"},{"text":"LogLevelSchema","link":"/en/api/@connectum/core/variables/LogLevelSchema.md"},{"text":"NodeEnvSchema","link":"/en/api/@connectum/core/variables/NodeEnvSchema.md"},{"text":"tlsPath","link":"/en/api/@connectum/core/variables/tlsPath.md"},{"text":"TRANSPORT_VALIDATION_ERROR_CODE","link":"/en/api/@connectum/core/variables/TRANSPORT_VALIDATION_ERROR_CODE.md"},{"text":"TransportValidationMode","link":"/en/api/@connectum/core/variables/TransportValidationMode.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"collectStreamingMethods","link":"/en/api/@connectum/core/functions/collectStreamingMethods.md"},{"text":"createCatalogClient","link":"/en/api/@connectum/core/functions/createCatalogClient.md"},{"text":"createLocalTransport","link":"/en/api/@connectum/core/functions/createLocalTransport.md"},{"text":"createServer","link":"/en/api/@connectum/core/functions/createServer.md"},{"text":"defineCatalog","link":"/en/api/@connectum/core/functions/defineCatalog.md"},{"text":"defineLazyService","link":"/en/api/@connectum/core/functions/defineLazyService.md"},{"text":"defineService","link":"/en/api/@connectum/core/functions/defineService.md"},{"text":"dnsResolver","link":"/en/api/@connectum/core/functions/dnsResolver.md"},{"text":"getTLSPath","link":"/en/api/@connectum/core/functions/getTLSPath.md"},{"text":"isSanitizableError","link":"/en/api/@connectum/core/functions/isSanitizableError.md"},{"text":"mapResolver","link":"/en/api/@connectum/core/functions/mapResolver.md"},{"text":"matchServicesPattern","link":"/en/api/@connectum/core/functions/matchServicesPattern.md"},{"text":"mergeCatalogs","link":"/en/api/@connectum/core/functions/mergeCatalogs.md"},{"text":"mergeEnabledServices","link":"/en/api/@connectum/core/functions/mergeEnabledServices.md"},{"text":"parseEnvConfig","link":"/en/api/@connectum/core/functions/parseEnvConfig.md"},{"text":"parseServicesEnv","link":"/en/api/@connectum/core/functions/parseServicesEnv.md"},{"text":"perServiceEnvResolver","link":"/en/api/@connectum/core/functions/perServiceEnvResolver.md"},{"text":"readTLSCertificates","link":"/en/api/@connectum/core/functions/readTLSCertificates.md"},{"text":"resolveEffectiveTransport","link":"/en/api/@connectum/core/functions/resolveEffectiveTransport.md"},{"text":"safeParseEnvConfig","link":"/en/api/@connectum/core/functions/safeParseEnvConfig.md"},{"text":"singleTransportResolver","link":"/en/api/@connectum/core/functions/singleTransportResolver.md"}]}]},{"text":"@connectum/events","link":"/en/api/@connectum/events/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"AdapterContext","link":"/en/api/@connectum/events/types/interfaces/AdapterContext.md"},{"text":"DlqOptions","link":"/en/api/@connectum/events/types/interfaces/DlqOptions.md"},{"text":"EventAdapter","link":"/en/api/@connectum/events/types/interfaces/EventAdapter.md"},{"text":"EventBus","link":"/en/api/@connectum/events/types/interfaces/EventBus.md"},{"text":"EventBusOptions","link":"/en/api/@connectum/events/types/interfaces/EventBusOptions.md"},{"text":"EventContext","link":"/en/api/@connectum/events/types/interfaces/EventContext.md"},{"text":"EventContextInit","link":"/en/api/@connectum/events/types/interfaces/EventContextInit.md"},{"text":"EventHandlerConfig","link":"/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md"},{"text":"EventRouteEntry","link":"/en/api/@connectum/events/types/interfaces/EventRouteEntry.md"},{"text":"EventRouter","link":"/en/api/@connectum/events/types/interfaces/EventRouter.md"},{"text":"EventSubscription","link":"/en/api/@connectum/events/types/interfaces/EventSubscription.md"},{"text":"MiddlewareConfig","link":"/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md"},{"text":"PublishOptions","link":"/en/api/@connectum/events/types/interfaces/PublishOptions.md"},{"text":"RawEvent","link":"/en/api/@connectum/events/types/interfaces/RawEvent.md"},{"text":"RawSubscribeOptions","link":"/en/api/@connectum/events/types/interfaces/RawSubscribeOptions.md"},{"text":"RetryOptions","link":"/en/api/@connectum/events/types/interfaces/RetryOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"EventMiddleware","link":"/en/api/@connectum/events/types/type-aliases/EventMiddleware.md"},{"text":"EventMiddlewareNext","link":"/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md"},{"text":"EventRoute","link":"/en/api/@connectum/events/types/type-aliases/EventRoute.md"},{"text":"RawEventHandler","link":"/en/api/@connectum/events/types/type-aliases/RawEventHandler.md"},{"text":"ServiceEventHandlers","link":"/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md"},{"text":"TypedEventHandler","link":"/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"EventRouterImpl","link":"/en/api/@connectum/events/classes/EventRouterImpl.md"},{"text":"NonRetryableError","link":"/en/api/@connectum/events/classes/NonRetryableError.md"},{"text":"RetryableError","link":"/en/api/@connectum/events/classes/RetryableError.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BroadcastReactor","link":"/en/api/@connectum/events/interfaces/BroadcastReactor.md"},{"text":"BroadcastSubscribersOptions","link":"/en/api/@connectum/events/interfaces/BroadcastSubscribersOptions.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"composeMiddleware","link":"/en/api/@connectum/events/functions/composeMiddleware.md"},{"text":"createBroadcastSubscribers","link":"/en/api/@connectum/events/functions/createBroadcastSubscribers.md"},{"text":"createEventBus","link":"/en/api/@connectum/events/functions/createEventBus.md"},{"text":"createEventContext","link":"/en/api/@connectum/events/functions/createEventContext.md"},{"text":"deriveServiceName","link":"/en/api/@connectum/events/functions/deriveServiceName.md"},{"text":"dlqMiddleware","link":"/en/api/@connectum/events/functions/dlqMiddleware.md"},{"text":"matchPattern","link":"/en/api/@connectum/events/functions/matchPattern.md"},{"text":"MemoryAdapter","link":"/en/api/@connectum/events/functions/MemoryAdapter.md"},{"text":"resolveTopicName","link":"/en/api/@connectum/events/functions/resolveTopicName.md"},{"text":"retryMiddleware","link":"/en/api/@connectum/events/functions/retryMiddleware.md"}]}]},{"text":"@connectum/events-amqp","link":"/en/api/@connectum/events-amqp/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-amqp/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"AmqpAdapterOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpAdapterOptions.md"},{"text":"AmqpBindingDeclaration","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpBindingDeclaration.md"},{"text":"AmqpConsumerOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md"},{"text":"AmqpExchangeDeclaration","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeDeclaration.md"},{"text":"AmqpExchangeOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md"},{"text":"AmqpLifecycleCallbacks","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpLifecycleCallbacks.md"},{"text":"AmqpPublisherOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md"},{"text":"AmqpQueueDeclaration","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueDeclaration.md"},{"text":"AmqpQueueOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md"},{"text":"AmqpQueueOverride","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOverride.md"},{"text":"AmqpRecoveryOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpRecoveryOptions.md"},{"text":"AmqpSerializationOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpSerializationOptions.md"},{"text":"AmqpTopology","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpTopology.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"AmqpTopologyMode","link":"/en/api/@connectum/events-amqp/types/type-aliases/AmqpTopologyMode.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"AmqpTopologyMode","link":"/en/api/@connectum/events-amqp/types/variables/AmqpTopologyMode.md"}]}]}]},{"text":"Classes","collapsed":true,"items":[{"text":"AmqpAdapterError","link":"/en/api/@connectum/events-amqp/classes/AmqpAdapterError.md"},{"text":"AmqpConnectionError","link":"/en/api/@connectum/events-amqp/classes/AmqpConnectionError.md"},{"text":"AmqpPublishNackError","link":"/en/api/@connectum/events-amqp/classes/AmqpPublishNackError.md"},{"text":"AmqpPublishTimeoutError","link":"/en/api/@connectum/events-amqp/classes/AmqpPublishTimeoutError.md"},{"text":"AmqpSerializationError","link":"/en/api/@connectum/events-amqp/classes/AmqpSerializationError.md"},{"text":"AmqpTopologyError","link":"/en/api/@connectum/events-amqp/classes/AmqpTopologyError.md"},{"text":"AmqpUnroutableError","link":"/en/api/@connectum/events-amqp/classes/AmqpUnroutableError.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"AmqpAdapter","link":"/en/api/@connectum/events-amqp/functions/AmqpAdapter.md"},{"text":"toAmqpPattern","link":"/en/api/@connectum/events-amqp/functions/toAmqpPattern.md"}]}]},{"text":"@connectum/events-kafka","link":"/en/api/@connectum/events-kafka/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-kafka/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"KafkaAdapterOptions","link":"/en/api/@connectum/events-kafka/types/interfaces/KafkaAdapterOptions.md"}]}]}]},{"text":"Functions","collapsed":true,"items":[{"text":"KafkaAdapter","link":"/en/api/@connectum/events-kafka/functions/KafkaAdapter.md"}]}]},{"text":"@connectum/events-nats","link":"/en/api/@connectum/events-nats/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-nats/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"NatsAdapterOptions","link":"/en/api/@connectum/events-nats/types/interfaces/NatsAdapterOptions.md"},{"text":"NatsConsumerOptions","link":"/en/api/@connectum/events-nats/types/interfaces/NatsConsumerOptions.md"}]}]}]},{"text":"Functions","collapsed":true,"items":[{"text":"NatsAdapter","link":"/en/api/@connectum/events-nats/functions/NatsAdapter.md"}]}]},{"text":"@connectum/events-redis","link":"/en/api/@connectum/events-redis/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"types","link":"/en/api/@connectum/events-redis/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"RedisAdapterOptions","link":"/en/api/@connectum/events-redis/types/interfaces/RedisAdapterOptions.md"},{"text":"RedisBrokerOptions","link":"/en/api/@connectum/events-redis/types/interfaces/RedisBrokerOptions.md"}]}]}]},{"text":"Functions","collapsed":true,"items":[{"text":"RedisAdapter","link":"/en/api/@connectum/events-redis/functions/RedisAdapter.md"}]}]},{"text":"@connectum/healthcheck","link":"/en/api/@connectum/healthcheck/","collapsed":true,"items":[{"text":"@connectum/healthcheck","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"HealthcheckManager","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/classes/HealthcheckManager.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"healthcheckManager","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/variables/healthcheckManager.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createHealthcheckManager","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHealthcheckManager.md"},{"text":"createHttpHealthHandler","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/createHttpHealthHandler.md"},{"text":"Healthcheck","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/Healthcheck.md"},{"text":"parseServiceFromUrl","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/functions/parseServiceFromUrl.md"}]}]},{"text":"@connectum/healthcheck/types","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"HealthcheckOptions","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/HealthcheckOptions.md"},{"text":"ServiceStatus","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/interfaces/ServiceStatus.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"ServingStatus","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/type-aliases/ServingStatus.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"ServingStatus","link":"/en/api/@connectum/healthcheck/@connectum/healthcheck/types/variables/ServingStatus.md"}]}]}]},{"text":"@connectum/interceptors","link":"/en/api/@connectum/interceptors/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"bulkhead","link":"/en/api/@connectum/interceptors/bulkhead/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createBulkheadInterceptor","link":"/en/api/@connectum/interceptors/bulkhead/functions/createBulkheadInterceptor.md"}]}]},{"text":"circuit-breaker","link":"/en/api/@connectum/interceptors/circuit-breaker/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createCircuitBreakerInterceptor","link":"/en/api/@connectum/interceptors/circuit-breaker/functions/createCircuitBreakerInterceptor.md"},{"text":"defaultFailurePredicate","link":"/en/api/@connectum/interceptors/circuit-breaker/functions/defaultFailurePredicate.md"}]}]},{"text":"defaults","link":"/en/api/@connectum/interceptors/defaults/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"DefaultInterceptorOptions","link":"/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createDefaultInterceptors","link":"/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md"}]}]},{"text":"errorHandler","link":"/en/api/@connectum/interceptors/errorHandler/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createErrorHandlerInterceptor","link":"/en/api/@connectum/interceptors/errorHandler/functions/createErrorHandlerInterceptor.md"}]}]},{"text":"fallback","link":"/en/api/@connectum/interceptors/fallback/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createFallbackInterceptor","link":"/en/api/@connectum/interceptors/fallback/functions/createFallbackInterceptor.md"}]}]},{"text":"logger","link":"/en/api/@connectum/interceptors/logger/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createLoggerInterceptor","link":"/en/api/@connectum/interceptors/logger/functions/createLoggerInterceptor.md"}]}]},{"text":"method-filter","link":"/en/api/@connectum/interceptors/method-filter/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createMethodFilterInterceptor","link":"/en/api/@connectum/interceptors/method-filter/functions/createMethodFilterInterceptor.md"}]}]},{"text":"retry","link":"/en/api/@connectum/interceptors/retry/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createRetryInterceptor","link":"/en/api/@connectum/interceptors/retry/functions/createRetryInterceptor.md"}]}]},{"text":"serializer","link":"/en/api/@connectum/interceptors/serializer/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createSerializerInterceptor","link":"/en/api/@connectum/interceptors/serializer/functions/createSerializerInterceptor.md"}]}]},{"text":"timeout","link":"/en/api/@connectum/interceptors/timeout/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createTimeoutInterceptor","link":"/en/api/@connectum/interceptors/timeout/functions/createTimeoutInterceptor.md"}]}]}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BulkheadOptions","link":"/en/api/@connectum/interceptors/interfaces/BulkheadOptions.md"},{"text":"CircuitBreakerOptions","link":"/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md"},{"text":"ErrorHandlerOptions","link":"/en/api/@connectum/interceptors/interfaces/ErrorHandlerOptions.md"},{"text":"FallbackOptions","link":"/en/api/@connectum/interceptors/interfaces/FallbackOptions.md"},{"text":"LoggerOptions","link":"/en/api/@connectum/interceptors/interfaces/LoggerOptions.md"},{"text":"RetryOptions","link":"/en/api/@connectum/interceptors/interfaces/RetryOptions.md"},{"text":"SerializerOptions","link":"/en/api/@connectum/interceptors/interfaces/SerializerOptions.md"},{"text":"TimeoutOptions","link":"/en/api/@connectum/interceptors/interfaces/TimeoutOptions.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"InterceptorFactory","link":"/en/api/@connectum/interceptors/type-aliases/InterceptorFactory.md"},{"text":"MethodFilterMap","link":"/en/api/@connectum/interceptors/type-aliases/MethodFilterMap.md"}]}]},{"text":"@connectum/otel","link":"/en/api/@connectum/otel/","collapsed":true,"items":[{"text":"Modules","collapsed":true,"items":[{"text":"attributes","link":"/en/api/@connectum/otel/attributes/","collapsed":true,"items":[{"text":"Type Aliases","collapsed":true,"items":[{"text":"ConnectErrorCode","link":"/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"ATTR_CONNECTUM_TRANSPORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md"},{"text":"ATTR_CONNECTUM_TRANSPORT_METRIC","link":"/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md"},{"text":"ATTR_ERROR_TYPE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_ERROR_TYPE.md"},{"text":"ATTR_NETWORK_PEER_ADDRESS","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_ADDRESS.md"},{"text":"ATTR_NETWORK_PEER_PORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PEER_PORT.md"},{"text":"ATTR_NETWORK_PROTOCOL_NAME","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_PROTOCOL_NAME.md"},{"text":"ATTR_NETWORK_TRANSPORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_NETWORK_TRANSPORT.md"},{"text":"ATTR_RPC_CONNECT_RPC_STATUS_CODE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_CONNECT_RPC_STATUS_CODE.md"},{"text":"ATTR_RPC_MESSAGE_ID","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_ID.md"},{"text":"ATTR_RPC_MESSAGE_TYPE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_TYPE.md"},{"text":"ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE.md"},{"text":"ATTR_RPC_METHOD","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_METHOD.md"},{"text":"ATTR_RPC_SERVICE","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SERVICE.md"},{"text":"ATTR_RPC_SYSTEM","link":"/en/api/@connectum/otel/attributes/variables/ATTR_RPC_SYSTEM.md"},{"text":"ATTR_SERVER_ADDRESS","link":"/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_ADDRESS.md"},{"text":"ATTR_SERVER_PORT","link":"/en/api/@connectum/otel/attributes/variables/ATTR_SERVER_PORT.md"},{"text":"ConnectErrorCode","link":"/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md"},{"text":"ConnectErrorCodeName","link":"/en/api/@connectum/otel/attributes/variables/ConnectErrorCodeName.md"},{"text":"CONNECTUM_INTERNAL_TRANSPORT_HEADER","link":"/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md"},{"text":"CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS","link":"/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md"},{"text":"RPC_MESSAGE_EVENT","link":"/en/api/@connectum/otel/attributes/variables/RPC_MESSAGE_EVENT.md"},{"text":"RPC_SYSTEM_CONNECT_RPC","link":"/en/api/@connectum/otel/attributes/variables/RPC_SYSTEM_CONNECT_RPC.md"}]}]},{"text":"client-interceptor","link":"/en/api/@connectum/otel/client-interceptor/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createOtelClientInterceptor","link":"/en/api/@connectum/otel/client-interceptor/functions/createOtelClientInterceptor.md"}]}]},{"text":"interceptor","link":"/en/api/@connectum/otel/interceptor/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"createOtelInterceptor","link":"/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md"}]}]},{"text":"logger","link":"/en/api/@connectum/otel/logger/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"Logger","link":"/en/api/@connectum/otel/logger/interfaces/Logger.md"},{"text":"LoggerOptions","link":"/en/api/@connectum/otel/logger/interfaces/LoggerOptions.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"getLogger","link":"/en/api/@connectum/otel/logger/functions/getLogger.md"}]}]},{"text":"meter","link":"/en/api/@connectum/otel/meter/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"getMeter","link":"/en/api/@connectum/otel/meter/functions/getMeter.md"}]}]},{"text":"metrics","link":"/en/api/@connectum/otel/metrics/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"RpcClientMetrics","link":"/en/api/@connectum/otel/metrics/interfaces/RpcClientMetrics.md"},{"text":"RpcServerMetrics","link":"/en/api/@connectum/otel/metrics/interfaces/RpcServerMetrics.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"createRpcClientMetrics","link":"/en/api/@connectum/otel/metrics/functions/createRpcClientMetrics.md"},{"text":"createRpcServerMetrics","link":"/en/api/@connectum/otel/metrics/functions/createRpcServerMetrics.md"}]}]},{"text":"provider","link":"/en/api/@connectum/otel/provider/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"ProviderOptions","link":"/en/api/@connectum/otel/provider/interfaces/ProviderOptions.md"},{"text":"ResourceAttributeInputs","link":"/en/api/@connectum/otel/provider/interfaces/ResourceAttributeInputs.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"buildResourceAttributes","link":"/en/api/@connectum/otel/provider/functions/buildResourceAttributes.md"},{"text":"getProvider","link":"/en/api/@connectum/otel/provider/functions/getProvider.md"},{"text":"initProvider","link":"/en/api/@connectum/otel/provider/functions/initProvider.md"},{"text":"parseOtelResourceAttributesEnv","link":"/en/api/@connectum/otel/provider/functions/parseOtelResourceAttributesEnv.md"},{"text":"shutdownProvider","link":"/en/api/@connectum/otel/provider/functions/shutdownProvider.md"}]}]},{"text":"shared","link":"/en/api/@connectum/otel/shared/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"BaseAttributeParams","link":"/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"applyAttributeFilter","link":"/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md"},{"text":"buildBaseAttributes","link":"/en/api/@connectum/otel/shared/functions/buildBaseAttributes.md"},{"text":"buildErrorAttributes","link":"/en/api/@connectum/otel/shared/functions/buildErrorAttributes.md"},{"text":"detectConnectumTransport","link":"/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md"},{"text":"estimateMessageSize","link":"/en/api/@connectum/otel/shared/functions/estimateMessageSize.md"},{"text":"wrapAsyncIterable","link":"/en/api/@connectum/otel/shared/functions/wrapAsyncIterable.md"}]}]},{"text":"traceAll","link":"/en/api/@connectum/otel/traceAll/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"traceAll","link":"/en/api/@connectum/otel/traceAll/functions/traceAll.md"}]}]},{"text":"traced","link":"/en/api/@connectum/otel/traced/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"traced","link":"/en/api/@connectum/otel/traced/functions/traced.md"}]}]},{"text":"tracer","link":"/en/api/@connectum/otel/tracer/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"getTracer","link":"/en/api/@connectum/otel/tracer/functions/getTracer.md"}]}]}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"BatchSpanProcessorOptions","link":"/en/api/@connectum/otel/interfaces/BatchSpanProcessorOptions.md"},{"text":"CollectorOptions","link":"/en/api/@connectum/otel/interfaces/CollectorOptions.md"},{"text":"Meter","link":"/en/api/@connectum/otel/interfaces/Meter.md"},{"text":"OtelBaseOptions","link":"/en/api/@connectum/otel/interfaces/OtelBaseOptions.md"},{"text":"OtelClientInterceptorOptions","link":"/en/api/@connectum/otel/interfaces/OtelClientInterceptorOptions.md"},{"text":"OtelInterceptorOptions","link":"/en/api/@connectum/otel/interfaces/OtelInterceptorOptions.md"},{"text":"OTLPSettings","link":"/en/api/@connectum/otel/interfaces/OTLPSettings.md"},{"text":"TraceAllOptions","link":"/en/api/@connectum/otel/interfaces/TraceAllOptions.md"},{"text":"TracedOptions","link":"/en/api/@connectum/otel/interfaces/TracedOptions.md"},{"text":"Tracer","link":"/en/api/@connectum/otel/interfaces/Tracer.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"ArgsFilter","link":"/en/api/@connectum/otel/type-aliases/ArgsFilter.md"},{"text":"ExporterType","link":"/en/api/@connectum/otel/type-aliases/ExporterType.md"},{"text":"MethodArgsFilter","link":"/en/api/@connectum/otel/type-aliases/MethodArgsFilter.md"},{"text":"OtelAttributeFilter","link":"/en/api/@connectum/otel/type-aliases/OtelAttributeFilter.md"},{"text":"OtelFilter","link":"/en/api/@connectum/otel/type-aliases/OtelFilter.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"ExporterType","link":"/en/api/@connectum/otel/variables/ExporterType.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"getBatchSpanProcessorOptions","link":"/en/api/@connectum/otel/functions/getBatchSpanProcessorOptions.md"},{"text":"getCollectorOptions","link":"/en/api/@connectum/otel/functions/getCollectorOptions.md"},{"text":"getOTLPSettings","link":"/en/api/@connectum/otel/functions/getOTLPSettings.md"},{"text":"getServiceMetadata","link":"/en/api/@connectum/otel/functions/getServiceMetadata.md"}]}]},{"text":"@connectum/reflection","link":"/en/api/@connectum/reflection/","collapsed":true,"items":[{"text":"Functions","collapsed":true,"items":[{"text":"collectFileProtos","link":"/en/api/@connectum/reflection/functions/collectFileProtos.md"},{"text":"Reflection","link":"/en/api/@connectum/reflection/functions/Reflection.md"}]}]},{"text":"@connectum/test-fixtures","link":"/en/api/@connectum/test-fixtures/","collapsed":true,"items":[{"text":"index","link":"/en/api/@connectum/test-fixtures/index/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"MockCall","link":"/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md"},{"text":"MockFn","link":"/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"assertConnectError","link":"/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md"},{"text":"createFakeMethod","link":"/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md"},{"text":"createFakeService","link":"/en/api/@connectum/test-fixtures/index/functions/createFakeService.md"},{"text":"createMockDescField","link":"/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md"},{"text":"createMockDescMessage","link":"/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md"},{"text":"createMockDescMethod","link":"/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md"},{"text":"createMockFn","link":"/en/api/@connectum/test-fixtures/index/functions/createMockFn.md"},{"text":"createMockNext","link":"/en/api/@connectum/test-fixtures/index/functions/createMockNext.md"},{"text":"createMockNextError","link":"/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md"},{"text":"createMockNextSlow","link":"/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md"},{"text":"createMockRequest","link":"/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md"},{"text":"createMockStream","link":"/en/api/@connectum/test-fixtures/index/functions/createMockStream.md"}]}]},{"text":"types","link":"/en/api/@connectum/test-fixtures/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"FakeMethodOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md"},{"text":"FakeServiceOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md"},{"text":"MockDescFieldOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md"},{"text":"MockDescMessageOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md"},{"text":"MockDescMethodOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md"},{"text":"MockNextOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md"},{"text":"MockRequestOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md"},{"text":"MockStreamOptions","link":"/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md"}]}]}]},{"text":"@connectum/testing","link":"/en/api/@connectum/testing/","collapsed":true,"items":[{"text":"index","link":"/en/api/@connectum/testing/index/","collapsed":true,"items":[{"text":"Classes","collapsed":true,"items":[{"text":"InMemoryMetricCollector","link":"/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md"},{"text":"InMemorySpanCollector","link":"/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md"}]},{"text":"Interfaces","collapsed":true,"items":[{"text":"CreateMockContextOptions","link":"/en/api/@connectum/testing/index/interfaces/CreateMockContextOptions.md"},{"text":"FakeMethodOptions","link":"/en/api/@connectum/testing/index/interfaces/FakeMethodOptions.md"},{"text":"FakeServiceOptions","link":"/en/api/@connectum/testing/index/interfaces/FakeServiceOptions.md"},{"text":"MockCall","link":"/en/api/@connectum/testing/index/interfaces/MockCall.md"},{"text":"MockDescFieldOptions","link":"/en/api/@connectum/testing/index/interfaces/MockDescFieldOptions.md"},{"text":"MockDescMessageOptions","link":"/en/api/@connectum/testing/index/interfaces/MockDescMessageOptions.md"},{"text":"MockDescMethodOptions","link":"/en/api/@connectum/testing/index/interfaces/MockDescMethodOptions.md"},{"text":"MockFn","link":"/en/api/@connectum/testing/index/interfaces/MockFn.md"},{"text":"MockNextOptions","link":"/en/api/@connectum/testing/index/interfaces/MockNextOptions.md"},{"text":"MockRequestOptions","link":"/en/api/@connectum/testing/index/interfaces/MockRequestOptions.md"},{"text":"MockService","link":"/en/api/@connectum/testing/index/interfaces/MockService.md"},{"text":"MockStreamOptions","link":"/en/api/@connectum/testing/index/interfaces/MockStreamOptions.md"},{"text":"NormalizedMetric","link":"/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md"},{"text":"NormalizedSpan","link":"/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md"}]},{"text":"Variables","collapsed":true,"items":[{"text":"MOCK_RESPONSE_HEADER","link":"/en/api/@connectum/testing/index/variables/MOCK_RESPONSE_HEADER.md"},{"text":"TRANSPORT_METRIC_ATTRIBUTE","link":"/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md"},{"text":"TRANSPORT_SPAN_ATTRIBUTE","link":"/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md"}]},{"text":"Functions","collapsed":true,"items":[{"text":"assertConnectError","link":"/en/api/@connectum/testing/index/functions/assertConnectError.md"},{"text":"createFakeMethod","link":"/en/api/@connectum/testing/index/functions/createFakeMethod.md"},{"text":"createFakeService","link":"/en/api/@connectum/testing/index/functions/createFakeService.md"},{"text":"createLocalClient","link":"/en/api/@connectum/testing/index/functions/createLocalClient.md"},{"text":"createMockContext","link":"/en/api/@connectum/testing/index/functions/createMockContext.md"},{"text":"createMockDescField","link":"/en/api/@connectum/testing/index/functions/createMockDescField.md"},{"text":"createMockDescMessage","link":"/en/api/@connectum/testing/index/functions/createMockDescMessage.md"},{"text":"createMockDescMethod","link":"/en/api/@connectum/testing/index/functions/createMockDescMethod.md"},{"text":"createMockFn","link":"/en/api/@connectum/testing/index/functions/createMockFn.md"},{"text":"createMockNext","link":"/en/api/@connectum/testing/index/functions/createMockNext.md"},{"text":"createMockNextError","link":"/en/api/@connectum/testing/index/functions/createMockNextError.md"},{"text":"createMockNextSlow","link":"/en/api/@connectum/testing/index/functions/createMockNextSlow.md"},{"text":"createMockRequest","link":"/en/api/@connectum/testing/index/functions/createMockRequest.md"},{"text":"createMockStream","link":"/en/api/@connectum/testing/index/functions/createMockStream.md"},{"text":"createTestServer","link":"/en/api/@connectum/testing/index/functions/createTestServer.md"},{"text":"mockResolver","link":"/en/api/@connectum/testing/index/functions/mockResolver.md"},{"text":"mockService","link":"/en/api/@connectum/testing/index/functions/mockService.md"},{"text":"withTestServer","link":"/en/api/@connectum/testing/index/functions/withTestServer.md"}]}]},{"text":"types","link":"/en/api/@connectum/testing/types/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"CreateTestServerOptions","link":"/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md"},{"text":"TestServer","link":"/en/api/@connectum/testing/types/interfaces/TestServer.md"}]}]}]}] \ No newline at end of file From 7bfda36637e20f64aaed880e9eedbea60e4d7895 Mon Sep 17 00:00:00 2001 From: intech Date: Mon, 22 Jun 2026 01:17:38 +0400 Subject: [PATCH 2/6] docs(packages): document the 1.1.0 APIs on the auth/core/events pages MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Mirror the package READMEs (verified against the real exports, each marked "since 1.1.0"): createCatalogClient (core); internal auth — createInternalAuthInterceptor + trust sources + getInternalMethods, links ADR-029, and the RS256 test helpers (auth); createBroadcastSubscribers + strictTopics (events). Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 --- en/packages/auth.md | 298 +++++++++++++++++++++++++++++++++++++++++- en/packages/core.md | 44 ++++++- en/packages/events.md | 81 ++++++++++++ 3 files changed, 415 insertions(+), 8 deletions(-) diff --git a/en/packages/auth.md b/en/packages/auth.md index e4f2f77e..9b479640 100644 --- a/en/packages/auth.md +++ b/en/packages/auth.md @@ -5,7 +5,7 @@ description: Authentication and authorization interceptors for Connectum # @connectum/auth -Authentication and authorization interceptors for ConnectRPC services. Provides server-side factories for the most common auth patterns -- generic pluggable auth, JWT (via jose), gateway-injected headers, session-based auth, and declarative authorization rules -- plus client-side factories (`createClientBearerInterceptor`, `createClientGatewayInterceptor`) for outbound service-to-service calls. All server interceptors propagate `AuthContext` through `AsyncLocalStorage` so handlers can access the authenticated identity without explicit parameter passing. +Authentication and authorization interceptors for ConnectRPC services. Provides server-side factories for the most common auth patterns -- generic pluggable auth, JWT (via jose), gateway-injected headers, session-based auth, internal service-to-service auth, and declarative authorization rules -- plus client-side factories (`createClientBearerInterceptor`, `createClientGatewayInterceptor`) for outbound service-to-service calls. All server interceptors propagate `AuthContext` through `AsyncLocalStorage` so handlers can access the authenticated identity without explicit parameter passing. **Layer**: 1 (Protocol) @@ -277,6 +277,215 @@ const sessionAuth = createSessionAuthInterceptor({ --- +### `createInternalAuthInterceptor(options)` + +::: tip Available since 1.1.0. +::: + +Internal (service-to-service) authentication interceptor ([ADR-029](/en/contributing/adr/029-internal-service-to-service-auth)). For methods marked `internal` in proto options, it authorizes the call from a configurable per-service **trust source** instead of an end-user token, rejecting a missing or invalid marker as `Code.Unauthenticated`. Non-internal methods are a **no-op pass-through**. + +```typescript +function createInternalAuthInterceptor(options: InternalAuthInterceptorOptions): Interceptor; +``` + +Internal methods skip end-user (JWT) authentication, so feed `getInternalMethods(services)` into the JWT interceptor's `skipMethods` (alongside `getPublicMethods(services)`); this interceptor then enforces the internal trust marker on those same methods. + +```typescript +import { + createInternalAuthInterceptor, + meshIdentityTrust, + createJwtAuthInterceptor, +} from '@connectum/auth'; +import { getInternalMethods, getPublicMethods } from '@connectum/auth/proto'; +import services from '#gen/services.js'; + +// JWT skips both public and internal methods; the internal interceptor +// then enforces the trust marker on the internal ones. +const jwtAuth = createJwtAuthInterceptor({ + jwksUri: 'https://auth.example.com/.well-known/jwks.json', + skipMethods: [...getPublicMethods(services), ...getInternalMethods(services)], +}); + +const internalAuth = createInternalAuthInterceptor({ + internalMethods: getInternalMethods(services), + trustSource: meshIdentityTrust({ + allowlist: [ + { principal: 'cluster.local/ns/default/sa/trips', roles: ['worker'] }, + ], + }), +}); +``` + +**Chain order (load-bearing)**. This interceptor MUST run **before** [`createProtoAuthzInterceptor`](#createprotoauthzinterceptor-options): it populates the `AuthContext` that proto-authz's `internal` rule consumes. + +```text +errorHandler -> (jwtAuth | internalAuth) -> protoAuthz +``` + +For an `internal` method, `createProtoAuthzInterceptor` composes the marker inclusively with the existing roles/scopes model: + +- `internal` + no identity (no `AuthContext`) -> `Unauthenticated` +- `internal` + no `requires` -> allow (any trusted internal caller) +- `internal` + `requires { roles | scopes }` -> the existing roles/scopes check against the same `AuthContext` + +Each shipped trust source strips its own trust header after extraction on the internal path (accept and reject) to prevent a spoofed marker from being propagated downstream. + +#### `InternalAuthInterceptorOptions` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `trustSource` | `InternalTrustSource` | **(required)** | Pluggable trust source that authorizes an internal call -- use `meshIdentityTrust`, `signedTokenTrust`, `sharedSecretTrust`, or a custom function. Returning `null` (or throwing) rejects the call as `Unauthenticated`. | +| `internalMethods` | `readonly string[]` | **(required)** | Method patterns enforced as internal (`"Service/Method"`, `"Service/*"`, or `"*"`). Typically `getInternalMethods(services)`. All other methods pass through unchanged. | + +::: tip Proto contract (additive) +`optional bool internal` was added to both `ServiceAuth` and `MethodAuth` in `connectum.auth.v1`. Marking a method `internal` instead of `public` removes world-open exposure while keeping it reachable by trusted callers (ADR-029). +::: + +--- + +### `meshIdentityTrust(options)` + +::: tip Available since 1.1.0. +::: + +Production-default trust source. Verifies a mesh-forwarded peer principal (an Istio short-form ServiceAccount principal `cluster.local/ns//sa/`, or a SPIFFE id) against an allow-list. Because the mesh issues each workload its own mTLS identity, matching the forwarded principal against the allow-list is **per-service by construction** -- compromising one workload cannot forge another's identity. The identity header is stripped after extraction (anti-spoofing). + +```typescript +function meshIdentityTrust(options: MeshIdentityTrustOptions): InternalTrustSource; +``` + +```typescript +import { createInternalAuthInterceptor, meshIdentityTrust } from '@connectum/auth'; +import { getInternalMethods } from '@connectum/auth/proto'; +import services from '#gen/services.js'; + +const internalAuth = createInternalAuthInterceptor({ + internalMethods: getInternalMethods(services), + trustSource: meshIdentityTrust({ + allowlist: [ + { principal: 'cluster.local/ns/default/sa/trips', roles: ['worker'], name: 'trips-service' }, + { principal: 'cluster.local/ns/default/sa/billing', scopes: ['charge'] }, + ], + }), +}); +``` + +#### `MeshIdentityTrustOptions` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `allowlist` | `readonly MeshIdentityEntry[]` | **(required)** | Permitted mesh identities. A non-empty list is enforced at construction (throws otherwise). A request whose principal is not on the list is rejected. | +| `header` | `string` | `"x-forwarded-client-principal"` | Header carrying the mesh-forwarded peer identity | +| `type` | `string` | `"mesh"` | Credential type set on the resulting `AuthContext` | + +#### `MeshIdentityEntry` + +| Field | Type | Required | Description | +|-------|------|----------|-------------| +| `principal` | `string` | Yes | Forwarded peer identity to match (Istio ServiceAccount principal or SPIFFE id) | +| `roles` | `readonly string[]` | No | Roles granted to this caller (compose via `requires { roles }`) | +| `scopes` | `readonly string[]` | No | Scopes granted to this caller (compose via `requires { scopes }`) | +| `name` | `string` | No | Human-readable name for the calling service | + +--- + +### `signedTokenTrust(options)` + +::: tip Available since 1.1.0. +::: + +Non-mesh, per-service trust source. Each caller signs a short-lived JWT with its **own** private key; this trust source verifies it against that service's published JWKS, so compromising service A's key forges only A. + +The keyset is selected by the token's claimed `iss` (`issuers[iss].jwksUri`), and verification is **pinned** to that same issuer -- each issuer gets its own `createRemoteJWKSet`, so no verification call ever receives a keyset spanning more than one issuer. A token claiming `iss: "B"` but signed with A's key is **rejected**. (A single shared JWKS holding multiple services' keys does NOT contain compromise, because `jose` resolves the signing key by `kid` independently of `iss`.) + +The framework ships only the verification primitive; key issuance, rotation, and JWKS publication belong to the deployment (SPIRE / the IdP / the mesh). + +```typescript +function signedTokenTrust(options: SignedTokenTrustOptions): InternalTrustSource; +``` + +```typescript +import { createInternalAuthInterceptor, signedTokenTrust } from '@connectum/auth'; +import { getInternalMethods } from '@connectum/auth/proto'; +import services from '#gen/services.js'; + +const internalAuth = createInternalAuthInterceptor({ + internalMethods: getInternalMethods(services), + trustSource: signedTokenTrust({ + issuers: { + 'trips-service': { + jwksUri: 'https://trips/.well-known/jwks.json', + claimsMapping: { roles: 'roles' }, + }, + 'billing-service': { jwksUri: 'https://billing/.well-known/jwks.json' }, + }, + }), +}); +``` + +#### `SignedTokenTrustOptions` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `issuers` | `Readonly>` | **(required)** | Per-issuer JWKS config keyed by the token's `iss` value. At least one issuer is enforced at construction (throws otherwise). | +| `header` | `string` | `"x-internal-token"` | Header carrying the service token (bare token or `Bearer `) | +| `type` | `string` | `"service"` | Credential type set on the resulting `AuthContext` | + +#### `SignedTokenIssuer` + +| Field | Type | Default | Description | +|-------|------|---------|-------------| +| `jwksUri` | `string` | **(required)** | The issuer's JWKS endpoint URL (its own keyset only) | +| `audience` | `string \| string[]` | -- | Expected audience(s) for tokens from this issuer | +| `algorithms` | `string[]` | `["RS256"]` | Allowed signing algorithms | +| `maxTokenAge` | `number \| string` | -- | Maximum token age (seconds or string like `"2h"`) | +| `claimsMapping` | `{ subject?, name?, roles?, scopes? }` | `{}` | Maps token claims to `AuthContext` (dot-notation). Subject defaults to the `sub` claim, else the issuer. | + +--- + +### `sharedSecretTrust(options)` + +::: tip Available since 1.1.0. +::: + +::: warning DEV-ONLY +A single shared secret is **not** per-service: every legitimate caller holds the same secret, so one compromise forges **all** internal identities. Use `meshIdentityTrust` (mesh) or `signedTokenTrust` (non-mesh per-service JWT) in production. This factory exists only for local development and single-tenant low-trust-boundary setups. +::: + +Constant-time compares a single shared secret against the trust header. The header is stripped after extraction (anti-spoofing). + +```typescript +function sharedSecretTrust(options: SharedSecretTrustOptions): InternalTrustSource; +``` + +```typescript +import { createInternalAuthInterceptor, sharedSecretTrust } from '@connectum/auth'; +import { getInternalMethods } from '@connectum/auth/proto'; +import services from '#gen/services.js'; + +const internalAuth = createInternalAuthInterceptor({ + internalMethods: getInternalMethods(services), + trustSource: sharedSecretTrust({ + secret: process.env.INTERNAL_SECRET ?? '', + subject: 'internal-batch', + roles: ['worker'], + }), +}); +``` + +#### `SharedSecretTrustOptions` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `secret` | `string` | **(required)** | Shared secret, constant-time compared against the header value. A non-empty secret is enforced at construction (throws otherwise). | +| `header` | `string` | `"x-internal-secret"` | Header carrying the shared secret | +| `subject` | `string` | `"internal"` | Subject identity assigned to a trusted call | +| `roles` | `readonly string[]` | `[]` | Roles granted to a trusted caller | +| `scopes` | `readonly string[]` | `[]` | Scopes granted to a trusted caller | +| `type` | `string` | `"internal"` | Credential type set on the resulting `AuthContext` | + +--- + ### `createAuthzInterceptor(options?)` Declarative rules-based authorization interceptor. Evaluates rules against `AuthContext` from the authentication interceptor. Must be placed **after** an auth interceptor in the chain. @@ -343,13 +552,15 @@ message AuthRequirements { message MethodAuth { optional bool public = 1; optional AuthRequirements requires = 2; - optional string policy = 3; // "allow" or "deny" + optional string policy = 3; // "allow" or "deny" + optional bool internal = 4; // service-to-service (since 1.1.0) } message ServiceAuth { optional string default_policy = 1; optional AuthRequirements default_requires = 2; optional bool public = 3; + optional bool internal = 4; // service-to-service (since 1.1.0) } extend google.protobuf.MethodOptions { @@ -397,8 +608,8 @@ function createProtoAuthzInterceptor(options?: ProtoAuthzInterceptorOptions): In 1. Read proto options via `resolveMethodAuth(req.method)` 2. `public = true` → skip (allow without authentication) -3. No auth context → throw `Unauthenticated` -4. `requires` defined → check roles/scopes → allow or deny +3. `internal = true` → if no auth context, throw `Unauthenticated`; if no `requires`, allow (any trusted internal caller); else fall through to step 4 +4. `requires` defined → if no auth context, throw `Unauthenticated`; check roles/scopes → allow or deny 5. `policy = "allow"` → allow 6. `policy = "deny"` → deny 7. Fallback: evaluate programmatic `rules` @@ -442,6 +653,7 @@ Results are cached in a `WeakMap` keyed by `DescMethod`. Priority: method → se ```typescript interface ResolvedMethodAuth { readonly public: boolean; + readonly internal: boolean; readonly policy: "allow" | "deny" | undefined; readonly requires: { readonly roles: readonly string[]; readonly scopes: readonly string[] } | undefined; } @@ -467,6 +679,28 @@ const authn = createJwtAuthInterceptor({ }); ``` +### `getInternalMethods(services)` + +::: tip Available since 1.1.0. +::: + +Extracts `internal` method patterns from service descriptors. Mirrors `getPublicMethods`: internal methods also skip end-user (JWT) authentication, so feed these into the JWT interceptor's `skipMethods` -- but, unlike public methods, they still require an internal trust marker enforced by [`createInternalAuthInterceptor`](#createinternalauthinterceptor-options). + +```typescript +function getInternalMethods(services: readonly DescService[]): string[]; +``` + +```typescript +import { getInternalMethods, getPublicMethods } from '@connectum/auth/proto'; + +// JWT auth skips both public and internal methods; +// the internal interceptor then enforces the trust marker on internal ones. +const jwtAuth = createJwtAuthInterceptor({ + jwksUri: '...', + skipMethods: [...getPublicMethods(services), ...getInternalMethods(services)], +}); +``` + ## Client-Side Interceptors Outbound ConnectRPC transports can attach authentication headers automatically using the client-side factories from `@connectum/auth`. These complement the server-side interceptors above and are meant for service-to-service calls. @@ -698,9 +932,49 @@ import { createMockAuthContext, createTestJwt, withAuthContext, TEST_JWT_SECRET | Export | Description | |--------|-------------| | `createMockAuthContext` | Create a mock `AuthContext` with sensible defaults | -| `createTestJwt` | Generate a signed JWT for testing | +| `createTestJwt` | Generate a signed HS256 JWT for testing | | `TEST_JWT_SECRET` | Pre-shared HMAC secret for test JWTs | | `withAuthContext` | Run a function within a given `AuthContext` (wraps `AsyncLocalStorage.run`) | +| `generateRsaTestKeypair` | _(1.1.0)_ Generate an RSA (RS256) test keypair + public JWK | +| `startTestJwksServer` | _(1.1.0)_ Start an in-process JWKS server publishing the public JWK(s) | +| `createTestJwtRS256` | _(1.1.0)_ Mint an RS256 test JWT verified through the production JWKS branch | +| `TEST_JWT_KID` | _(1.1.0)_ Default `kid` shared by the RS256 helpers (`"connectum-test-key"`) | + +### RS256 + JWKS test helpers + +::: tip Available since 1.1.0. +::: + +The production-realistic auth path with an external IdP is RS256 tokens validated through a JWKS endpoint -- `createJwtAuthInterceptor({ jwksUri })`, the `jose.createRemoteJWKSet` branch. Unlike `createTestJwt` (HS256-only), these helpers exercise that asymmetric path: `generateRsaTestKeypair` produces an RSA keypair plus a public JWK (carrying `kid`/`alg: "RS256"`/`use: "sig"`), `startTestJwksServer` publishes it at `/.well-known/jwks.json` on a random loopback port, and `createTestJwtRS256` mints a token with a matching `kid` header. The `options` argument of `createTestJwtRS256` and its `kid` field are **required** -- the `kid` must match the published JWK or key selection fails. + +```typescript +import { + generateRsaTestKeypair, + startTestJwksServer, + createTestJwtRS256, +} from '@connectum/auth/testing'; +import { createJwtAuthInterceptor } from '@connectum/auth'; + +const keypair = await generateRsaTestKeypair(); +// { privateKey, publicKey, publicJwk, kid } +const jwks = await startTestJwksServer(keypair.publicJwk); // or an array of JWKs + +const auth = createJwtAuthInterceptor({ + jwksUri: jwks.url, + issuer: 'https://issuer.example', + audience: 'my-api', + algorithms: ['RS256'], +}); + +const token = await createTestJwtRS256( + keypair.privateKey, + { sub: 'user-123', roles: ['admin'], scope: 'read write' }, + { kid: keypair.kid, issuer: 'https://issuer.example', audience: 'my-api' }, +); + +// ...exercise the interceptor with `Authorization: Bearer ${token}`... +await jwks.close(); +``` ## Security Considerations @@ -719,6 +993,10 @@ import { createMockAuthContext, createTestJwt, withAuthContext, TEST_JWT_SECRET | `createJwtAuthInterceptor` | `.` | JWT authentication interceptor (jose) | | `createGatewayAuthInterceptor` | `.` | Gateway-injected headers authentication interceptor | | `createSessionAuthInterceptor` | `.` | Session-based authentication interceptor | +| `createInternalAuthInterceptor` | `.` | Internal (service-to-service) trust marker interceptor | +| `meshIdentityTrust` | `.` | Trust source: mesh-forwarded peer identity (Istio/SPIFFE) | +| `signedTokenTrust` | `.` | Trust source: per-service signed token via issuer-bound JWKS | +| `sharedSecretTrust` | `.` | Trust source: dev-only single shared secret | | `createClientBearerInterceptor` | `.` | Client-side Bearer token interceptor | | `createClientGatewayInterceptor` | `.` | Client-side gateway service-to-service auth interceptor | | `createAuthzInterceptor` | `.` | Declarative rules-based authorization interceptor | @@ -733,17 +1011,23 @@ import { createMockAuthContext, createTestJwt, withAuthContext, TEST_JWT_SECRET | `AUTH_HEADERS` | `.` | Standard auth header name constants | | `AuthzEffect` | `.` | Authorization effect constants (ALLOW, DENY) | | `createProtoAuthzInterceptor` | `.` | Proto-based authorization interceptor | -| `AuthContext`, `AuthInterceptorOptions`, `JwtAuthInterceptorOptions`, `GatewayAuthInterceptorOptions`, `GatewayHeaderMapping`, `SessionAuthInterceptorOptions`, `ClientBearerInterceptorOptions`, `ClientGatewayInterceptorOptions`, `AuthzInterceptorOptions`, `AuthzRule`, `ProtoAuthzInterceptorOptions`, `CacheOptions`, `InterceptorFactory`, `AuthzDeniedDetails` | `.` | TypeScript types | +| `AuthContext`, `AuthInterceptorOptions`, `JwtAuthInterceptorOptions`, `GatewayAuthInterceptorOptions`, `GatewayHeaderMapping`, `SessionAuthInterceptorOptions`, `InternalAuthInterceptorOptions`, `InternalTrustSource`, `MeshIdentityEntry`, `MeshIdentityTrustOptions`, `SignedTokenIssuer`, `SignedTokenTrustOptions`, `SharedSecretTrustOptions`, `ClientBearerInterceptorOptions`, `ClientGatewayInterceptorOptions`, `AuthzInterceptorOptions`, `AuthzRule`, `ProtoAuthzInterceptorOptions`, `CacheOptions`, `InterceptorFactory`, `AuthzDeniedDetails` | `.` | TypeScript types | | `createProtoAuthzInterceptor` | `./proto` | Proto-based authorization interceptor | | `resolveMethodAuth` | `./proto` | Resolve proto auth config for a method | | `getPublicMethods` | `./proto` | Extract public method patterns from services | +| `getInternalMethods` | `./proto` | Extract internal method patterns from services | | `AuthRequirements`, `MethodAuth`, `ServiceAuth` | `./proto` | Generated proto message types | | `AuthRequirementsSchema`, `MethodAuthSchema`, `ServiceAuthSchema` | `./proto` | Generated proto schemas | | `method_auth`, `service_auth` | `./proto` | Proto extension descriptors | | `createMockAuthContext` | `./testing` | Create mock AuthContext for tests | -| `createTestJwt` | `./testing` | Generate signed test JWTs | +| `createTestJwt` | `./testing` | Generate signed HS256 test JWTs | | `TEST_JWT_SECRET` | `./testing` | Pre-shared HMAC secret for tests | | `withAuthContext` | `./testing` | Run function within AuthContext | +| `generateRsaTestKeypair` | `./testing` | Generate an RSA (RS256) test keypair + public JWK | +| `startTestJwksServer` | `./testing` | Start an in-process JWKS server for tests | +| `createTestJwtRS256` | `./testing` | Mint an RS256 test JWT (production JWKS branch) | +| `TEST_JWT_KID` | `./testing` | Default `kid` for the RS256 test helpers | +| `RsaTestKeypair`, `TestJwksServer` | `./testing` | TypeScript types for the RS256 helpers | ## Related Packages diff --git a/en/packages/core.md b/en/packages/core.md index e3e7a1d6..e4b79860 100644 --- a/en/packages/core.md +++ b/en/packages/core.md @@ -230,6 +230,47 @@ The in-process transport is available immediately after `createServer({...})` [In-Process Transport](/en/guide/production/in-process-transport) — motivation, polyglot deployment pattern, observability parity, limitations. ::: +### `createCatalogClient(options)` + +_Available since 1.1.0._ + +A standalone, catalog-typed client that exposes the **same** typed `call` (unary) and `stream` (server/client/bidi) surface as the in-handler `ctx.call` / `ctx.stream`, but usable **outside** a `Server` — in a Temporal worker, a scheduler, or a CLI — without constructing a server. + +```typescript +function createCatalogClient(options: CreateCatalogClientOptions): CatalogClient; +``` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `catalog` | `ServiceCatalog` | **(required)** | The service catalog backing typed dispatch — the same object passed to `createServer({ catalog })`. | +| `resolver` | `RemoteResolver` | **(required)** | Resolves every target's transport (`singleTransportResolver` / `mapResolver` / `dnsResolver` / `perServiceEnvResolver`). | + +Returns a `CatalogClient` — `{ call, stream }`, keyed off the generated `ConnectumCallMap` / `ConnectumStreamMap`, so calls are statically checked exactly as on the handler `ctx`. + +```typescript +import { createCatalogClient, mapResolver } from '@connectum/core'; +import { createGrpcTransport } from '@connectrpc/connect-node'; +import { serviceCatalog } from '#gen/catalog.js'; // from @connectum/protoc-gen-catalog + +const client = createCatalogClient({ + catalog: serviceCatalog, + resolver: mapResolver({ + 'trip.v1.TripService': createGrpcTransport({ baseUrl: process.env.TRIP_ADDR ?? 'http://localhost:8080' }), + }), +}); + +// Fully typed off the generated catalog — same surface as ctx.call: +const trip = await client.call('trip.v1.TripService/StartTrip', { vehicleId: 'veh-42' }); +``` + +Every target is routed through the supplied `RemoteResolver`, and the resolved transport is cached per `(typeName, endpoint)`. There is **no** in-process/local path: a service the resolver cannot resolve fails with `Code.Unavailable`. The rest of the error model mirrors `ctx.call` — an unknown service/method (or wrong method kind) fails with `Code.Unimplemented`, and a resolver that throws surfaces as `Code.Internal` (cause preserved). + +::: warning No inbound request to cascade from +Unlike `ctx.call`, there is no inbound request, so `CallOptions` are applied **verbatim**: the `signal` / `timeoutMs` are **not** cascaded or clamped, no inbound headers are propagated, and no `ContextValues` are forwarded. +::: + +See [Service Catalog](/en/guide/service-communication/service-catalog) for the catalog model and resolver wiring. + ### `ServerState` ```typescript @@ -385,6 +426,7 @@ See [Runtime Support: Node.js vs Bun vs tsx](/en/guide/typescript/runtime-suppor | Export | Subpath | Description | |--------|---------|-------------| | `createServer` | `.` | Server factory function | +| `createCatalogClient` | `.` | Standalone catalog-typed `call` / `stream` client usable outside a `Server` (since 1.1.0) | | `createLocalTransport` | `.` | In-process transport factory ([guide](/en/guide/production/in-process-transport)) | | `defineService`, `defineLazyService` | `.` | Service registration (descriptor + handlers); the `services` entries | | `defineCatalog`, `mergeCatalogs` | `.` | Service catalog construction ([guide](/en/guide/service-communication/service-catalog)) | @@ -397,7 +439,7 @@ See [Runtime Support: Node.js vs Bun vs tsx](/en/guide/typescript/runtime-suppor | `isSanitizableError` | `.` | Type guard for `SanitizableError` protocol | | `getTLSPath`, `readTLSCertificates`, `tlsPath` | `.` | TLS utilities | | `EventBusLike` | `.` | Event bus lifecycle interface | -| `SanitizableError`, `Server`, `CreateServerOptions`, `ShutdownOptions`, `ServiceDefinition`, `ServiceOptions`, `Context`, `CallOptions`, `ServiceCatalog`, `RemoteResolver`, etc. | `.` | TypeScript types | +| `CatalogClient`, `CreateCatalogClientOptions` (since 1.1.0), `SanitizableError`, `Server`, `CreateServerOptions`, `ShutdownOptions`, `ServiceDefinition`, `ServiceOptions`, `Context`, `CallOptions`, `ServiceCatalog`, `RemoteResolver`, etc. | `.` | TypeScript types | | `parseEnvConfig`, `safeParseEnvConfig`, schemas | `./config` | Env configuration | ## Related Packages diff --git a/en/packages/events.md b/en/packages/events.md index 26c88088..e84a951c 100644 --- a/en/packages/events.md +++ b/en/packages/events.md @@ -136,6 +136,7 @@ function createEventBus(options: EventBusOptions): EventBus & EventBusLike; | `drainTimeout` | `number` | `30000` | Max ms to wait for in-flight handlers during `stop()` | | `middleware` | `MiddlewareConfig` | `undefined` | Middleware configuration (retry, DLQ, custom) | | `publishes` | `DescService[]` | `[]` | Event service descriptors this process publishes to (publisher-only, no subscription) | +| `strictTopics` | `boolean` | `false` | Throw on an unresolved publish topic instead of silently falling back to the message `typeName`. Available since 1.1.0. | ### `EventBus` @@ -193,6 +194,83 @@ function createEventBus(options: EventBusOptions): EventBus & EventBusLike; | `topic` | `string` | *required* | DLQ topic name | | `errorSerializer` | `(error: unknown) => string` | `error.name` | Custom error serializer for DLQ metadata | +### `createBroadcastSubscribers(options)` + +Builds 1→N fan-out wiring: one `EventBus` per reactor, each on its own consumer group, so a single published event is delivered to every reactor independently. + +Available since 1.1.0. + +```typescript +function createBroadcastSubscribers( + options: BroadcastSubscribersOptions, +): Array; +``` + +Delivering one published event to N **independent** reactors requires one `EventBus` **per reactor**, each with its own consumer group: + +- The per-bus duplicate-topic guard rejects two routes resolving to the same topic on one bus, so reactors cannot share a bus. +- On a real broker, a **shared** group load-balances (one reactor "steals" each event), while **distinct** groups give each reactor its own durable consumer. + +`createBroadcastSubscribers()` constructs that one-bus-per-reactor wiring from a list of reactors, so callers do not hand-roll N `createEventBus()` calls. It **throws** if two reactors share a consumer group. + +::: warning +The returned buses are **not started** -- start (and later stop) them yourself. +::: + +```typescript +import { createBroadcastSubscribers } from '@connectum/events'; +import { NatsAdapter } from '@connectum/events-nats'; + +// Per-bus adapter factory: each reactor bus gets its own connection / durable consumer +const buses = createBroadcastSubscribers({ + adapter: () => NatsAdapter({ servers: 'nats://localhost:4222' }), + reactors: [ + { group: 'pricing', routes: [pricingRoutes] }, + { group: 'audit', routes: [auditRoutes] }, + { group: 'notify', routes: [notifyRoutes] }, + ], +}); + +await Promise.all(buses.map((bus) => bus.start())); + +// On shutdown: +await Promise.all(buses.map((bus) => bus.stop())); +``` + +For in-process tests, pass a single shared `MemoryAdapter()` instance instead of a factory (all buses share the in-memory registry): + +```typescript +import { createBroadcastSubscribers, MemoryAdapter } from '@connectum/events'; + +const buses = createBroadcastSubscribers({ + adapter: MemoryAdapter(), // one shared instance + reactors: [ + { group: 'pricing', routes: [pricingRoutes] }, + { group: 'audit', routes: [auditRoutes] }, + ], +}); + +await Promise.all(buses.map((bus) => bus.start())); +``` + +### `BroadcastSubscribersOptions` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `adapter` | `EventAdapter \| (() => EventAdapter)` | *required* | One shared adapter instance (fine for `MemoryAdapter` in tests) **or** a factory invoked once per reactor (use for real brokers so each bus gets its own connection / durable consumer) | +| `reactors` | `BroadcastReactor[]` | *required* | The independent reactors -- each becomes its own `EventBus` with its own group | +| `handlerTimeout` | `number` | `30000` | Shared per-bus handler timeout in ms | +| `drainTimeout` | `number` | `30000` | Shared per-bus drain timeout in ms | +| `signal` | `AbortSignal` | `undefined` | Shared abort signal for graceful shutdown | + +### `BroadcastReactor` + +| Option | Type | Default | Description | +|--------|------|---------|-------------| +| `group` | `string` | *required* | Consumer group -- MUST be distinct per reactor for true fan-out (a shared group load-balances) | +| `routes` | `EventRoute[]` | *required* | The event routes (handlers) this reactor subscribes with | +| `middleware` | `MiddlewareConfig` | `undefined` | Optional per-reactor middleware (retry / DLQ / custom) | + ## Middleware The middleware pipeline uses an onion model (outer to inner): @@ -240,6 +318,7 @@ const eventBus = createEventBus({ | Export | Description | |--------|-------------| | `createEventBus` | EventBus factory function | +| `createBroadcastSubscribers` | 1→N fan-out factory: one `EventBus` per reactor, each with its own consumer group, so every reactor receives every event (available since 1.1.0) | | `deriveServiceName` | Derives a service identifier from proto service type names (format: `{packages}@{hostname}`) | | `createEventContext` | EventContext factory (advanced) | | `EventRouterImpl` | EventRouter implementation class | @@ -258,6 +337,8 @@ const eventBus = createEventBus({ |------|-------------| | `EventBus` | EventBus interface | | `EventBusOptions` | EventBus configuration | +| `BroadcastSubscribersOptions` | Options for `createBroadcastSubscribers()` (available since 1.1.0) | +| `BroadcastReactor` | One broadcast reactor: `group` + `routes` + optional `middleware` (available since 1.1.0) | | `AdapterContext` | Context passed to adapters on connect (contains `serviceName`) | | `EventAdapter` | Adapter interface | | `EventRouter` | Router interface | From a4f79fab12778f63443e86a1fca0f95f285857c6 Mon Sep 17 00:00:00 2001 From: intech Date: Mon, 22 Jun 2026 01:20:54 +0400 Subject: [PATCH 3/6] docs(auth): document the `internal` proto-authz marker in the guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add `internal` to the proto-authz guide alongside `public`: the service-level and method-level option tables, the authorization priority order (internal → reject if no identity / allow if no requires / else evaluate requires), and the merge-precedence table. Links ADR-029; marked "since 1.1.0". Verified against options.proto (optional bool internal on ServiceAuth + MethodAuth) and the createProtoAuthzInterceptor resolution order. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 --- en/guide/auth/proto-authz.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/en/guide/auth/proto-authz.md b/en/guide/auth/proto-authz.md index 4ef5b702..32020b8f 100644 --- a/en/guide/auth/proto-authz.md +++ b/en/guide/auth/proto-authz.md @@ -56,6 +56,7 @@ service UserService { | `default_policy` | `string` | `"allow"` or `"deny"` when no rule matches | | `default_requires` | `AuthRequirements` | Default roles/scopes for all methods | | `public` | `bool` | Mark all methods as public (skip authn + authz) | +| `internal` | `bool` | Mark all methods as internal (service-to-service). Skips end-user JWT auth; requires a trust marker from `createInternalAuthInterceptor`. Since 1.1.0. See [ADR-029](/en/contributing/adr/029-internal-service-to-service-auth). | #### `method_auth` (method-level) @@ -64,6 +65,7 @@ service UserService { | `public` | `bool` | Skip authentication and authorization | | `requires` | `AuthRequirements` | Required roles and/or scopes | | `policy` | `string` | Override service-level default policy | +| `internal` | `bool` | Mark the method as internal (service-to-service). Distinct from `public`: world-open vs. trusted-caller-only. Since 1.1.0. | #### `AuthRequirements` @@ -106,8 +108,10 @@ The interceptor resolves authorization in this priority: ``` 1. Proto `public` option → allow (skip authn + authz) -2. Check auth context exists → reject if unauthenticated -3. Proto `requires` option → check roles/scopes +2. Proto `internal` option → if no auth context, reject (Unauthenticated); + if no `requires`, allow (any trusted internal caller); + else evaluate `requires` in step 3 +3. Proto `requires` option → if no auth context, reject (Unauthenticated); check roles/scopes 4. Proto `policy` → apply "allow" or "deny" 5. Programmatic rules → evaluate in order 6. `authorize` callback → custom logic @@ -150,6 +154,7 @@ Service-level defaults are merged with method-level overrides: | Setting | Method-level | Service-level | Default | |---------|-------------|--------------|---------| | `public` | `method_auth.public` | `service_auth.public` | `false` | +| `internal` | `method_auth.internal` | `service_auth.internal` | `false` | | `requires` | `method_auth.requires` | `service_auth.default_requires` | none | | `policy` | `method_auth.policy` | `service_auth.default_policy` | none | From 853e4ff8de84ec7190c717a611f6288f7cbb1fc4 Mon Sep 17 00:00:00 2001 From: intech Date: Mon, 22 Jun 2026 01:41:47 +0400 Subject: [PATCH 4/6] =?UTF-8?q?docs:=20currency=20fixes=20=E2=80=94=20pnpm?= =?UTF-8?q?=20>=3D11,=20createCatalogClient=20cross-refs,=20k8s=20link?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Verified-accurate doc-currency fixes (surfaced by the doc-currency review, each checked against source before applying): - pnpm floor 10 → 11 in cli-commands / development-setup / quickstart — connectum's package.json `engines.pnpm` is ">=11" (packageManager pinned to pnpm@11.0.4); the prose had lagged. - createCatalogClient (1.1.0) cross-referenced where the catalog/resolver are documented: service-catalog (a no-Server usage example), resolvers (the third resolver consumer), protoc-gen-catalog (the catalog also types it). - cli page: note `connectum --version`. - kubernetes: the car-sharing/k8s pointer referenced a non-existent `secret-jwt.yaml`; reworded to the actual `configmap.yaml` + Istio-mTLS setup. The auth/core/events package pages from the same review were superseded by the fuller versions already in this PR. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 --- en/contributing/cli-commands.md | 4 ++-- en/contributing/development-setup.md | 4 ++-- en/guide/production/kubernetes.md | 2 +- en/guide/quickstart.md | 2 +- en/guide/service-communication/resolvers.md | 4 ++-- .../service-communication/service-catalog.md | 18 ++++++++++++++++++ en/packages/cli.md | 4 ++-- en/packages/protoc-gen-catalog.md | 6 +++--- 8 files changed, 31 insertions(+), 13 deletions(-) diff --git a/en/contributing/cli-commands.md b/en/contributing/cli-commands.md index 2a9b0c04..7d9285a2 100644 --- a/en/contributing/cli-commands.md +++ b/en/contributing/cli-commands.md @@ -7,7 +7,7 @@ Complete reference of CLI commands for working with the Connectum monorepo. ## Prerequisites - **Node.js**: >=25.2.0 (for development), >=22.13.0 (for consumers) -- **pnpm**: 10+ +- **pnpm**: 11+ - **Buf**: provided by the `@bufbuild/buf` workspace devDependency (no standalone install); proto generation runs via `pnpm build:proto` ### Installation Check @@ -17,7 +17,7 @@ Complete reference of CLI commands for working with the Connectum monorepo. node --version # Should be >= 25.2.0 for development (>= 22.13.0 for consumers) # Check pnpm version -pnpm --version # Should be >= 10.0.0 +pnpm --version # Should be >= 11.0.0 # Buf is bundled as a workspace devDependency; verify proto generation pnpm build:proto diff --git a/en/contributing/development-setup.md b/en/contributing/development-setup.md index 4d95dc45..cf14e124 100644 --- a/en/contributing/development-setup.md +++ b/en/contributing/development-setup.md @@ -5,7 +5,7 @@ How to set up the development environment for contributing to Connectum. ## Requirements - Node.js >= 25.2.0 -- pnpm >= 10 +- pnpm >= 11 ## Quick Start @@ -35,7 +35,7 @@ pnpm install node --version # >= 25.2.0 # Check pnpm -pnpm --version # >= 10 +pnpm --version # >= 11 # Type checking pnpm typecheck diff --git a/en/guide/production/kubernetes.md b/en/guide/production/kubernetes.md index 78a8aa2e..ff21ec50 100644 --- a/en/guide/production/kubernetes.md +++ b/en/guide/production/kubernetes.md @@ -55,7 +55,7 @@ See [configmap.yaml](https://github.com/Connectum-Framework/examples/blob/main/c Store TLS certificates and sensitive configuration in Secrets. For application-level TLS, create a `kubernetes.io/tls` secret holding the service's TLS certificate and private key, and mount it into the pod. -For an example Secret manifest, see the [car-sharing/k8s](https://github.com/Connectum-Framework/examples/tree/main/car-sharing/k8s) directory (`secret-jwt.yaml` shows the Secret pattern; that example relies on Istio for mTLS rather than application-level TLS). +The [car-sharing/k8s](https://github.com/Connectum-Framework/examples/tree/main/car-sharing/k8s) example relies on Istio for mTLS rather than application-level TLS secrets; it stores gateway configuration (identity provider endpoints) in `configmap.yaml` instead. ::: tip For production TLS, consider using [cert-manager](https://cert-manager.io/) to automatically provision and renew certificates. If you are using Istio, the service mesh handles mTLS automatically and you may not need application-level TLS at all. diff --git a/en/guide/quickstart.md b/en/guide/quickstart.md index 4a2a7756..de5ae38b 100644 --- a/en/guide/quickstart.md +++ b/en/guide/quickstart.md @@ -11,7 +11,7 @@ Build a fully functional gRPC/ConnectRPC microservice with health checks, server ## Prerequisites - **Node.js >= 25.2.0** -- native TypeScript via [type stripping](https://nodejs.org/api/typescript.html) -- **pnpm >= 10** -- `corepack enable && corepack prepare pnpm@latest --activate` +- **pnpm >= 11** -- `corepack enable && corepack prepare pnpm@latest --activate` - **buf** -- installed automatically via `@bufbuild/buf` npm package ::: tip Node.js version for consumers diff --git a/en/guide/service-communication/resolvers.md b/en/guide/service-communication/resolvers.md index 041b2b45..342c5f0f 100644 --- a/en/guide/service-communication/resolvers.md +++ b/en/guide/service-communication/resolvers.md @@ -4,9 +4,9 @@ outline: deep # Remote Resolvers -A **remote resolver** is the service-catalog routing layer: it maps a proto service identity to the `Transport` used to reach that service when it is *not* mounted on the local server. The unified client factory (`server.client(Desc)`) and the catalog primitive (`ctx.call(...)`) both consult it — locally-mounted services dispatch in-process and never touch the resolver, everything else is resolved through it. +A **remote resolver** is the service-catalog routing layer: it maps a proto service identity to the `Transport` used to reach that service. Three APIs consult it: the unified client factory (`server.client(Desc)`), the catalog primitive (`ctx.call(...)`), and the standalone catalog client (`createCatalogClient(...)`). For the first two, locally-mounted services dispatch in-process and never touch the resolver; everything else is resolved through it. `createCatalogClient` has no local server, so every call goes through the resolver unconditionally. -You configure one resolver per server via `createServer({ remoteResolver })`. The framework calls it lazily, on the first route to a given service, and caches the result. +You pass a resolver to `createServer({ remoteResolver })` for server-side routing, or directly to `createCatalogClient({ resolver })` for out-of-process workers, schedulers, and CLIs. The framework calls it lazily, on the first route to a given service, and caches the result. ## The `RemoteResolver` contract diff --git a/en/guide/service-communication/service-catalog.md b/en/guide/service-communication/service-catalog.md index 9c024d0e..80731199 100644 --- a/en/guide/service-communication/service-catalog.md +++ b/en/guide/service-communication/service-catalog.md @@ -223,6 +223,24 @@ const client = server.client(InventoryService); // local or remote — same ca const stock = await client.checkStock({ sku: 'A-1' }); ``` +Both `server.localClient` and `server.client` require a `Server` instance. For a process with **no server at all** — a Temporal worker, a scheduler, a CLI — use `createCatalogClient`. It provides the same catalog-typed `call`/`stream` surface as the handler `ctx`, routing every call through the supplied resolver (there is no in-process path without a `Server`): + +```typescript +import { createCatalogClient, mapResolver } from '@connectum/core'; +import { createGrpcTransport } from '@connectrpc/connect-node'; +import { serviceCatalog } from './gen/catalog.js'; + +const client = createCatalogClient({ + catalog: serviceCatalog, + resolver: mapResolver({ + 'inventory.v1.InventoryService': createGrpcTransport({ baseUrl: process.env.INVENTORY_ADDR }), + }), +}); + +const stock = await client.call('inventory.v1.InventoryService/CheckStock', { sku: 'A-1' }); +// ctx.stream mirrors: client.stream('...')(request) for server-streaming, etc. +``` + ## Error model Connectum splits **configuration mistakes** (programmer errors, thrown eagerly) from **operational failures** (runtime, mapped to RPC status codes). diff --git a/en/packages/cli.md b/en/packages/cli.md index 49398892..a63956ee 100644 --- a/en/packages/cli.md +++ b/en/packages/cli.md @@ -1,11 +1,11 @@ --- title: '@connectum/cli' -description: CLI tools for Connectum -- proto sync via gRPC Server Reflection +description: CLI tools for Connectum -- proto sync via gRPC Server Reflection, version reporting --- # @connectum/cli -Command-line tools for the Connectum framework. Currently provides the `proto sync` command -- a pipeline that connects to a running Connectum server via gRPC Server Reflection, discovers all services and proto definitions, and generates TypeScript client types using `buf generate`. +Command-line tools for the Connectum framework. Provides `connectum --version` (reports the installed CLI version) and the `proto sync` command -- a pipeline that connects to a running Connectum server via gRPC Server Reflection, discovers all services and proto definitions, and generates TypeScript client types using `buf generate`. **Layer**: 2 (CLI tooling) diff --git a/en/packages/protoc-gen-catalog.md b/en/packages/protoc-gen-catalog.md index ba425713..4b9387d8 100644 --- a/en/packages/protoc-gen-catalog.md +++ b/en/packages/protoc-gen-catalog.md @@ -6,8 +6,8 @@ description: Buf/protoc plugin that generates the typed Connectum service catalo # @connectum/protoc-gen-catalog A Buf/protoc plugin that generates a **Connectum service catalog** from your -proto files. The generated `catalog.gen.ts` is what makes `ctx.call` and -`ctx.stream` (from `@connectum/core`) fully typed. +proto files. The generated `catalog.gen.ts` is what makes `ctx.call`, +`ctx.stream`, and `createCatalogClient` (from `@connectum/core`) fully typed. **Layer**: 2 (Codegen tooling) @@ -32,7 +32,7 @@ not imported at runtime. One `catalog.gen.ts` per buf module, containing: - a runtime `serviceCatalog` object keyed by proto `typeName` — pass it to - `createServer({ catalog: serviceCatalog })`; + `createServer({ catalog: serviceCatalog })` or `createCatalogClient({ catalog: serviceCatalog })`; - module augmentation of `@connectum/core`'s `ConnectumCallMap` (unary methods) and `ConnectumStreamMap` (streaming methods), typing every `ctx.call` / `ctx.stream` key. From 787dfd5db6c1049a0e5a4a9d421509c82141ff5c Mon Sep 17 00:00:00 2001 From: intech Date: Mon, 22 Jun 2026 16:06:24 +0400 Subject: [PATCH 5/6] docs: drop internal ADR-NNN citations from example code comments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Example/demo code on the site (the homepage "See It in Action" snippet and the auth / interceptors guide snippets) cited internal ADR numbers in code comments ("ADR-024 order", "(ADR-024)"). A reader copying the example has no context for an ADR number — it is internal jargon in code that should be clean and self-explanatory. Replaced with plain wording ("Fixed-order chain", "Recommended order"); the architectural rationale still lives in the ADR pages and prose, not in example code. Co-Authored-By: Claude Opus 4.8 Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 --- en/guide/auth.md | 2 +- en/guide/auth/authorization.md | 2 +- en/guide/interceptors/custom.md | 2 +- en/index.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/en/guide/auth.md b/en/guide/auth.md index a73678f0..b30ff26f 100644 --- a/en/guide/auth.md +++ b/en/guide/auth.md @@ -49,7 +49,7 @@ const authz = createProtoAuthzInterceptor({ defaultPolicy: 'deny' }); const server = createServer({ services: [routes], - // ADR-024 order: errorHandler -> AUTH -> AUTHZ -> rest. + // Recommended order: errorHandler -> AUTH -> AUTHZ -> rest. // createDefaultInterceptors has no auth slot, so compose manually: // put errorHandler first, auth next, then disable the default errorHandler. interceptors: [ diff --git a/en/guide/auth/authorization.md b/en/guide/auth/authorization.md index bc5bee49..e7f54c2a 100644 --- a/en/guide/auth/authorization.md +++ b/en/guide/auth/authorization.md @@ -117,7 +117,7 @@ const authz = createAuthzInterceptor({ const server = createServer({ services: [routes], - // ADR-024 order: errorHandler -> AUTH -> AUTHZ -> rest. + // Recommended order: errorHandler -> AUTH -> AUTHZ -> rest. interceptors: [ createErrorHandlerInterceptor(), jwtAuth, diff --git a/en/guide/interceptors/custom.md b/en/guide/interceptors/custom.md index f295c8ad..42cbc34d 100644 --- a/en/guide/interceptors/custom.md +++ b/en/guide/interceptors/custom.md @@ -172,7 +172,7 @@ Auth interceptors must be placed **immediately after** `errorHandler`, before ti ::: ```typescript -// Manual chain with auth (ADR-024 order): +// Manual chain with auth (recommended order): // errorHandler -> AUTH -> AUTHZ -> timeout -> ... import { createErrorHandlerInterceptor, diff --git a/en/index.md b/en/index.md index 8f0c3e0a..67727baf 100644 --- a/en/index.md +++ b/en/index.md @@ -135,8 +135,8 @@ const server = createServer({ services: [deploymentService], port: 5000, protocols: [Healthcheck({ httpEnabled: true }), Reflection()], - // Fixed-order chain (ADR-024): errorHandler first, then auth/authz immediately - // after it, then observability and the default validation chain. + // Fixed-order chain: errorHandler first, then auth/authz immediately after + // it, then observability and the default validation chain. interceptors: [ createErrorHandlerInterceptor({ logErrors: true }), createJwtAuthInterceptor({ jwksUri: process.env.JWKS_URI! }), From 7beb5cac5e178a7ea2663f6b205a6a6436bc57b7 Mon Sep 17 00:00:00 2001 From: intech Date: Wed, 24 Jun 2026 21:19:43 +0400 Subject: [PATCH 6/6] docs(api): regenerate 1.1.0 API reference + package tables for the #185/#186 fields MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The API reference on this branch was generated before externalContract (#185) and caller-set messageId/timestamp (#186) landed on connectum main, so three published 1.1.0 fields were missing. Regenerate against current main and document them on the narrative package pages. - en/api: TypeDoc regen — adds PublishOptions.messageId / timestamp and AmqpPublisherOptions.externalContract. Remaining churn is source-link updates (protobuf-es 2.12.0 → 2.12.1, shifted line numbers in events src). - en/packages/events.md: PublishOptions table gains messageId / timestamp. - en/packages/events-amqp.md: AmqpPublisherOptions table gains externalContract; the External AMQP Contract recipe now sets externalContract: true and the clean-wire note is corrected — correlationHeader: false alone leaves the envelope headers on the wire. VitePress build passes (no dead links). Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3 Co-authored-by: Claude Opus 4.8 --- .../auth/classes/AuthzDeniedError.md | 20 +++++----- en/api/@connectum/core/interfaces/Context.md | 22 +++++------ .../events-amqp/functions/AmqpAdapter.md | 5 ++- .../types/interfaces/AmqpPublisherOptions.md | 38 +++++++++++++++++++ .../events/types/interfaces/AdapterContext.md | 4 +- .../events/types/interfaces/DlqOptions.md | 6 +-- .../events/types/interfaces/EventAdapter.md | 12 +++--- .../events/types/interfaces/EventBus.md | 8 ++-- .../types/interfaces/EventBusOptions.md | 20 +++++----- .../events/types/interfaces/EventContext.md | 18 ++++----- .../types/interfaces/EventContextInit.md | 10 ++--- .../types/interfaces/EventHandlerConfig.md | 6 +-- .../types/interfaces/EventRouteEntry.md | 10 ++--- .../events/types/interfaces/EventRouter.md | 4 +- .../types/interfaces/MiddlewareConfig.md | 8 ++-- .../events/types/interfaces/PublishOptions.md | 27 +++++++++++++ .../events/types/interfaces/RetryOptions.md | 14 +++---- .../types/type-aliases/EventMiddleware.md | 2 +- .../types/type-aliases/EventMiddlewareNext.md | 2 +- .../events/types/type-aliases/EventRoute.md | 2 +- .../type-aliases/ServiceEventHandlers.md | 2 +- .../types/type-aliases/TypedEventHandler.md | 2 +- en/packages/events-amqp.md | 12 ++++-- en/packages/events.md | 2 + 24 files changed, 165 insertions(+), 91 deletions(-) diff --git a/en/api/@connectum/auth/classes/AuthzDeniedError.md b/en/api/@connectum/auth/classes/AuthzDeniedError.md index ea639c61..b56e1276 100644 --- a/en/api/@connectum/auth/classes/AuthzDeniedError.md +++ b/en/api/@connectum/auth/classes/AuthzDeniedError.md @@ -53,7 +53,7 @@ Defined in: [packages/auth/src/errors.ts:29](https://github.com/Connectum-Framew > **cause**: `unknown` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:46 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:46 The underlying cause of this error, if any. In cases where the actual cause is elided with the error message, the cause is specified here so that we @@ -81,7 +81,7 @@ Defined in: [packages/auth/src/errors.ts:27](https://github.com/Connectum-Framew > `readonly` **code**: `Code` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:20 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:20 The Code for this error. @@ -95,7 +95,7 @@ The Code for this error. > **details**: (`OutgoingDetail` \| `IncomingDetail`)[] -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:32 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:32 When an error is parsed from the wire, incoming error details are stored in this property. They can be retrieved using findDetails(). @@ -125,7 +125,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `readonly` **metadata**: `Headers` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:24 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:24 A union of response headers and trailers associated with this error. @@ -139,7 +139,7 @@ A union of response headers and trailers associated with this error. > **name**: `string` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:40 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:40 #### Inherited from @@ -151,7 +151,7 @@ Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2. > `readonly` **rawMessage**: `string` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:39 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:39 The error message, but without a status code in front. @@ -230,7 +230,7 @@ Defined in: [packages/auth/src/errors.ts:31](https://github.com/Connectum-Framew > **findDetails**\<`Desc`\>(`desc`): `MessageShape`\<`Desc`\>[] -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:77 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:77 Retrieve error details from a ConnectError. On the wire, error details are wrapped with google.protobuf.Any, so that a server or middleware can attach @@ -263,7 +263,7 @@ omitted from the list. > **findDetails**(`registry`): `Message`[] -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:78 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:78 Retrieve error details from a ConnectError. On the wire, error details are wrapped with google.protobuf.Any, so that a server or middleware can attach @@ -292,7 +292,7 @@ omitted from the list. > `static` **\[hasInstance\]**(`v`): `boolean` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:68 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:68 #### Parameters @@ -384,7 +384,7 @@ a(); > `static` **from**(`reason`, `code?`): `ConnectError` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:67 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:67 Convert any value - typically a caught error into a ConnectError, following these rules: diff --git a/en/api/@connectum/core/interfaces/Context.md b/en/api/@connectum/core/interfaces/Context.md index f742275a..b20c7f9c 100644 --- a/en/api/@connectum/core/interfaces/Context.md +++ b/en/api/@connectum/core/interfaces/Context.md @@ -41,7 +41,7 @@ A `"${typeName}/${Method}"` key of [ConnectumCallMap](ConnectumCallMap.md). > `readonly` **method**: `DescMethod` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:21 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:21 Metadata for the method being called. @@ -55,7 +55,7 @@ Metadata for the method being called. > `readonly` **protocolName**: `string` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:62 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:62 Name of the RPC protocol in use; one of "connect", "grpc" or "grpc-web". @@ -69,7 +69,7 @@ Name of the RPC protocol in use; one of "connect", "grpc" or "grpc-web". > `readonly` **requestHeader**: `Headers` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:47 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:47 Incoming request headers. @@ -83,7 +83,7 @@ Incoming request headers. > `readonly` **requestMethod**: `string` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:43 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:43 HTTP method of incoming request, usually "POST", but "GET" in the case of Connect Get. @@ -98,7 +98,7 @@ Connect Get. > `readonly` **responseHeader**: `Headers` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:54 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:54 Outgoing response headers. @@ -115,7 +115,7 @@ yielding the first response message. > `readonly` **responseTrailer**: `Headers` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:58 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:58 Outgoing response trailers. @@ -129,7 +129,7 @@ Outgoing response trailers. > `readonly` **service**: `DescService` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:25 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:25 Metadata for the service being called. @@ -143,7 +143,7 @@ Metadata for the service being called. > `readonly` **signal**: `AbortSignal` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:33 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:33 An AbortSignal that triggers when the deadline is reached, or when an error occurs that aborts processing of the request, but also when the RPC is @@ -183,7 +183,7 @@ A `"${typeName}/${Method}"` key of [ConnectumStreamMap](ConnectumStreamMap.md). > `readonly` **timeoutMs**: () => `number` \| `undefined` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:38 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:38 If the current request has a timeout, this function returns the remaining time. @@ -202,7 +202,7 @@ time. > `readonly` **url**: `string` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:70 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:70 The URL received by the server. @@ -216,7 +216,7 @@ The URL received by the server. > `readonly` **values**: `ContextValues` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:66 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.2\_@bufbuild+protobuf@2.12.1/node\_modules/@connectrpc/connect/dist/esm/implementation.d.ts:66 Per RPC context values that can be used to pass data to handlers. diff --git a/en/api/@connectum/events-amqp/functions/AmqpAdapter.md b/en/api/@connectum/events-amqp/functions/AmqpAdapter.md index 774b88d0..500cc4e9 100644 --- a/en/api/@connectum/events-amqp/functions/AmqpAdapter.md +++ b/en/api/@connectum/events-amqp/functions/AmqpAdapter.md @@ -4,7 +4,7 @@ > **AmqpAdapter**(`options`): `EventAdapter` -Defined in: [packages/events-amqp/src/AmqpAdapter.ts:152](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/AmqpAdapter.ts#L152) +Defined in: [packages/events-amqp/src/AmqpAdapter.ts:153](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/AmqpAdapter.ts#L153) Create an AMQP/RabbitMQ adapter for @connectum/events. @@ -55,6 +55,7 @@ const adapter = AmqpAdapter({ bindings: [{ queue: "partner.inbound.v1", source: "partner.direct", routingKey: "inbound" }], }, queueOverrides: { partner: { queue: "partner.inbound.v1" } }, - publisherOptions: { persistent: true, mandatory: true }, + // externalContract: emit only contract-specified properties (no envelope). + publisherOptions: { persistent: true, mandatory: true, externalContract: true }, }); ``` diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md index d31ed849..7d1ae9a4 100644 --- a/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md +++ b/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md @@ -32,6 +32,44 @@ true *** +### externalContract? + +> `readonly` `optional` **externalContract?**: `boolean` + +Defined in: [packages/events-amqp/src/types.ts:362](https://github.com/Connectum-Framework/connectum/blob/main/packages/events-amqp/src/types.ts#L362) + +Publish against an EXTERNAL (non-EventBus) message contract: suppress the +EventBus envelope so the wire frame carries ONLY contract-specified +properties. For an external AsyncAPI/AMQP contract the oracle is the +published spec, not this serializer — a third-party consumer validates the +exact header/property set, which must not include adapter-internal fields. + +When `true`, `publish()`: +- does NOT stamp the `x-event-id` / `x-published-at` headers; +- does NOT auto-populate the `messageId` or `timestamp` properties; +- uses single-flight correlation for `mandatory` publishes (so no + `x-connectum-publish-id` header reaches the wire) — `correlationHeader` + is ignored in this mode. + +The frame then carries only `contentType`, `persistent`/deliveryMode, +`mandatory`, and exactly the headers passed via `PublishOptions.metadata`. +Per-message confirms, `mandatory` → `AmqpUnroutableError`, the typed error +taxonomy, and connection recovery are unchanged. + +Leave unset (default) for normal EventBus use, where the envelope is +stamped on publish and stripped on delivery. When the contract requires a +specific `messageId` / `timestamp`, set them per-publish via +`PublishOptions.messageId` / `PublishOptions.timestamp` (a caller-supplied +value is used as-is; in external-contract mode nothing is auto-generated). + +#### Default + +```ts +false +``` + +*** + ### mandatory? > `readonly` `optional` **mandatory?**: `boolean` diff --git a/en/api/@connectum/events/types/interfaces/AdapterContext.md b/en/api/@connectum/events/types/interfaces/AdapterContext.md index 15c3cf89..60210f93 100644 --- a/en/api/@connectum/events/types/interfaces/AdapterContext.md +++ b/en/api/@connectum/events/types/interfaces/AdapterContext.md @@ -2,7 +2,7 @@ # Interface: AdapterContext -Defined in: [packages/events/src/types.ts:78](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L78) +Defined in: [packages/events/src/types.ts:93](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L93) Context provided to adapters by the EventBus before connect(). @@ -17,7 +17,7 @@ Redis connectionName). > `readonly` `optional` **serviceName?**: `string` -Defined in: [packages/events/src/types.ts:88](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L88) +Defined in: [packages/events/src/types.ts:103](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L103) Service identifier derived from proto service names. diff --git a/en/api/@connectum/events/types/interfaces/DlqOptions.md b/en/api/@connectum/events/types/interfaces/DlqOptions.md index 5dc2da5c..f135cd5d 100644 --- a/en/api/@connectum/events/types/interfaces/DlqOptions.md +++ b/en/api/@connectum/events/types/interfaces/DlqOptions.md @@ -2,7 +2,7 @@ # Interface: DlqOptions -Defined in: [packages/events/src/types.ts:267](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L267) +Defined in: [packages/events/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L282) Dead letter queue middleware options @@ -12,7 +12,7 @@ Dead letter queue middleware options > `optional` **errorSerializer?**: (`error`) => `string` -Defined in: [packages/events/src/types.ts:276](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L276) +Defined in: [packages/events/src/types.ts:291](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L291) Custom error serializer for DLQ metadata. Defaults to `error.name` only (e.g. "TypeError") to prevent credential leaks. @@ -35,6 +35,6 @@ For production, provide a custom serializer that redacts sensitive data > **topic**: `string` -Defined in: [packages/events/src/types.ts:269](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L269) +Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L284) DLQ topic name diff --git a/en/api/@connectum/events/types/interfaces/EventAdapter.md b/en/api/@connectum/events/types/interfaces/EventAdapter.md index fbd3a55b..5e086299 100644 --- a/en/api/@connectum/events/types/interfaces/EventAdapter.md +++ b/en/api/@connectum/events/types/interfaces/EventAdapter.md @@ -2,7 +2,7 @@ # Interface: EventAdapter -Defined in: [packages/events/src/types.ts:97](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L97) +Defined in: [packages/events/src/types.ts:112](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L112) Minimal adapter interface for message brokers. @@ -15,7 +15,7 @@ config in constructor, not in interface methods. > `readonly` **name**: `string` -Defined in: [packages/events/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L99) +Defined in: [packages/events/src/types.ts:114](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L114) Adapter name for identification (e.g., "nats", "kafka", "redis", "memory") @@ -25,7 +25,7 @@ Adapter name for identification (e.g., "nats", "kafka", "redis", "memory") > **connect**(`context?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L108) +Defined in: [packages/events/src/types.ts:123](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L123) Connect to the message broker. @@ -49,7 +49,7 @@ Optional adapter context with service-level information > **disconnect**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:111](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L111) +Defined in: [packages/events/src/types.ts:126](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L126) Disconnect from the message broker @@ -63,7 +63,7 @@ Disconnect from the message broker > **publish**(`eventType`, `payload`, `options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:114](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L114) +Defined in: [packages/events/src/types.ts:129](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L129) Publish a serialized event to a topic @@ -91,7 +91,7 @@ Publish a serialized event to a topic > **subscribe**(`patterns`, `handler`, `options?`): `Promise`\<[`EventSubscription`](EventSubscription.md)\> -Defined in: [packages/events/src/types.ts:117](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L117) +Defined in: [packages/events/src/types.ts:132](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L132) Subscribe to event patterns with a raw handler diff --git a/en/api/@connectum/events/types/interfaces/EventBus.md b/en/api/@connectum/events/types/interfaces/EventBus.md index fd79f489..94efc24b 100644 --- a/en/api/@connectum/events/types/interfaces/EventBus.md +++ b/en/api/@connectum/events/types/interfaces/EventBus.md @@ -2,7 +2,7 @@ # Interface: EventBus -Defined in: [packages/events/src/types.ts:357](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L357) +Defined in: [packages/events/src/types.ts:372](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L372) EventBus interface -- manages adapter, routes, and middleware @@ -12,7 +12,7 @@ EventBus interface -- manages adapter, routes, and middleware > **publish**\<`Desc`\>(`schema`, `data`, `options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:371](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L371) +Defined in: [packages/events/src/types.ts:386](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L386) Publish a typed event @@ -46,7 +46,7 @@ Publish a typed event > **start**(`options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:367](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L367) +Defined in: [packages/events/src/types.ts:382](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L382) Start the event bus: connect adapter, set up subscriptions. @@ -74,7 +74,7 @@ shutdown or per-event timeout will abort in-flight processing. > **stop**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:369](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L369) +Defined in: [packages/events/src/types.ts:384](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L384) Stop the event bus: drain subscriptions, disconnect adapter diff --git a/en/api/@connectum/events/types/interfaces/EventBusOptions.md b/en/api/@connectum/events/types/interfaces/EventBusOptions.md index c24392ab..c90aded1 100644 --- a/en/api/@connectum/events/types/interfaces/EventBusOptions.md +++ b/en/api/@connectum/events/types/interfaces/EventBusOptions.md @@ -2,7 +2,7 @@ # Interface: EventBusOptions -Defined in: [packages/events/src/types.ts:294](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L294) +Defined in: [packages/events/src/types.ts:309](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L309) EventBus configuration options for createEventBus() @@ -12,7 +12,7 @@ EventBus configuration options for createEventBus() > **adapter**: [`EventAdapter`](EventAdapter.md) -Defined in: [packages/events/src/types.ts:296](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L296) +Defined in: [packages/events/src/types.ts:311](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L311) Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter) @@ -22,7 +22,7 @@ Adapter instance (e.g., NatsAdapter, KafkaAdapter, MemoryAdapter) > `optional` **drainTimeout?**: `number` -Defined in: [packages/events/src/types.ts:337](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L337) +Defined in: [packages/events/src/types.ts:352](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L352) Maximum time in milliseconds to wait for in-flight event handlers to complete during shutdown. After this timeout, remaining handlers @@ -36,7 +36,7 @@ Default: 30000 (30 seconds). Set to 0 for immediate abort. > `optional` **group?**: `string` -Defined in: [packages/events/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L312) +Defined in: [packages/events/src/types.ts:327](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L327) Consumer group name @@ -46,7 +46,7 @@ Consumer group name > `optional` **handlerTimeout?**: `number` -Defined in: [packages/events/src/types.ts:329](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L329) +Defined in: [packages/events/src/types.ts:344](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L344) Per-event handler timeout in milliseconds. @@ -59,7 +59,7 @@ this duration. Default: 30000 (30 seconds). > `optional` **middleware?**: [`MiddlewareConfig`](MiddlewareConfig.md) -Defined in: [packages/events/src/types.ts:314](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L314) +Defined in: [packages/events/src/types.ts:329](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L329) Middleware configuration @@ -69,7 +69,7 @@ Middleware configuration > `optional` **publishes?**: `DescService`[] -Defined in: [packages/events/src/types.ts:310](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L310) +Defined in: [packages/events/src/types.ts:325](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L325) Event service descriptors this bus publishes to (publish-only, no subscription). @@ -87,7 +87,7 @@ hand-maintaining raw topic strings. Subscribers still register via `routes`. > `optional` **routes?**: [`EventRoute`](../type-aliases/EventRoute.md)[] -Defined in: [packages/events/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L298) +Defined in: [packages/events/src/types.ts:313](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L313) Event routes to register @@ -97,7 +97,7 @@ Event routes to register > `optional` **signal?**: `AbortSignal` -Defined in: [packages/events/src/types.ts:322](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L322) +Defined in: [packages/events/src/types.ts:337](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L337) Abort signal for graceful shutdown. @@ -111,7 +111,7 @@ Automatically set when used with `createServer({ eventBus })`. > `optional` **strictTopics?**: `boolean` -Defined in: [packages/events/src/types.ts:351](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L351) +Defined in: [packages/events/src/types.ts:366](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L366) Reject a `publish()` whose topic cannot be resolved instead of silently falling back to the message `typeName`. diff --git a/en/api/@connectum/events/types/interfaces/EventContext.md b/en/api/@connectum/events/types/interfaces/EventContext.md index 2d1ce839..d534b627 100644 --- a/en/api/@connectum/events/types/interfaces/EventContext.md +++ b/en/api/@connectum/events/types/interfaces/EventContext.md @@ -2,7 +2,7 @@ # Interface: EventContext -Defined in: [packages/events/src/types.ts:131](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L131) +Defined in: [packages/events/src/types.ts:146](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L146) Per-event context with explicit ack/nack control. @@ -16,7 +16,7 @@ without calling either, the event is automatically acknowledged. > `readonly` **attempt**: `number` -Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L141) +Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L156) Delivery attempt number (1-based) @@ -26,7 +26,7 @@ Delivery attempt number (1-based) > `readonly` **eventId**: `string` -Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L135) +Defined in: [packages/events/src/types.ts:150](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L150) Unique event identifier @@ -36,7 +36,7 @@ Unique event identifier > `readonly` **eventType**: `string` -Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L137) +Defined in: [packages/events/src/types.ts:152](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L152) Event type / topic name @@ -46,7 +46,7 @@ Event type / topic name > `readonly` **metadata**: `ReadonlyMap`\<`string`, `string`\> -Defined in: [packages/events/src/types.ts:143](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L143) +Defined in: [packages/events/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L158) Event metadata (headers) @@ -56,7 +56,7 @@ Event metadata (headers) > `readonly` **publishedAt**: `Date` -Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L139) +Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L154) When the event was published @@ -66,7 +66,7 @@ When the event was published > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L133) +Defined in: [packages/events/src/types.ts:148](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L148) Abort signal (aborted when server is shutting down) @@ -76,7 +76,7 @@ Abort signal (aborted when server is shutting down) > **ack**(): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L145) +Defined in: [packages/events/src/types.ts:160](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L160) Acknowledge successful processing @@ -90,7 +90,7 @@ Acknowledge successful processing > **nack**(`requeue?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L147) +Defined in: [packages/events/src/types.ts:162](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L162) Negative acknowledge -- request redelivery or send to DLQ diff --git a/en/api/@connectum/events/types/interfaces/EventContextInit.md b/en/api/@connectum/events/types/interfaces/EventContextInit.md index c3f748c3..4448233c 100644 --- a/en/api/@connectum/events/types/interfaces/EventContextInit.md +++ b/en/api/@connectum/events/types/interfaces/EventContextInit.md @@ -2,7 +2,7 @@ # Interface: EventContextInit -Defined in: [packages/events/src/types.ts:153](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L153) +Defined in: [packages/events/src/types.ts:168](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L168) Initialization data for creating an EventContext @@ -12,7 +12,7 @@ Initialization data for creating an EventContext > `readonly` **onAck**: () => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L156) +Defined in: [packages/events/src/types.ts:171](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L171) #### Returns @@ -24,7 +24,7 @@ Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Fram > `readonly` **onNack**: (`requeue`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L157) +Defined in: [packages/events/src/types.ts:172](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L172) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Fram > `readonly` **raw**: [`RawEvent`](RawEvent.md) -Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L154) +Defined in: [packages/events/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L169) *** @@ -50,4 +50,4 @@ Defined in: [packages/events/src/types.ts:154](https://github.com/Connectum-Fram > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:155](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L155) +Defined in: [packages/events/src/types.ts:170](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L170) diff --git a/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md b/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md index 2d5ff56f..b7fa8d44 100644 --- a/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md +++ b/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md @@ -2,7 +2,7 @@ # Interface: EventHandlerConfig\ -Defined in: [packages/events/src/types.ts:176](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L176) +Defined in: [packages/events/src/types.ts:191](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L191) Per-handler middleware configuration. @@ -22,7 +22,7 @@ and only the per-handler middleware array is applied. > `readonly` **handler**: [`TypedEventHandler`](../type-aliases/TypedEventHandler.md)\<`I`\> -Defined in: [packages/events/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L178) +Defined in: [packages/events/src/types.ts:193](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L193) Event handler function @@ -32,6 +32,6 @@ Event handler function > `readonly` `optional` **middleware?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[] -Defined in: [packages/events/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L180) +Defined in: [packages/events/src/types.ts:195](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L195) Per-handler middleware array (overrides global middleware for this handler) diff --git a/en/api/@connectum/events/types/interfaces/EventRouteEntry.md b/en/api/@connectum/events/types/interfaces/EventRouteEntry.md index 61bda8c5..6906450b 100644 --- a/en/api/@connectum/events/types/interfaces/EventRouteEntry.md +++ b/en/api/@connectum/events/types/interfaces/EventRouteEntry.md @@ -2,7 +2,7 @@ # Interface: EventRouteEntry -Defined in: [packages/events/src/types.ts:197](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L197) +Defined in: [packages/events/src/types.ts:212](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L212) Registered event route (internal use) @@ -12,7 +12,7 @@ Registered event route (internal use) > `readonly` **handler**: [`TypedEventHandler`](../type-aliases/TypedEventHandler.md)\<`unknown`\> -Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L203) +Defined in: [packages/events/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L218) Typed handler function @@ -22,7 +22,7 @@ Typed handler function > `readonly` **method**: `DescMethod` -Defined in: [packages/events/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L201) +Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L216) Method descriptor for deserialization @@ -32,7 +32,7 @@ Method descriptor for deserialization > `readonly` `optional` **middleware?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[] -Defined in: [packages/events/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L205) +Defined in: [packages/events/src/types.ts:220](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L220) Per-handler middleware (overrides global when present) @@ -42,6 +42,6 @@ Per-handler middleware (overrides global when present) > `readonly` **topic**: `string` -Defined in: [packages/events/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L199) +Defined in: [packages/events/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L214) Topic pattern to subscribe to diff --git a/en/api/@connectum/events/types/interfaces/EventRouter.md b/en/api/@connectum/events/types/interfaces/EventRouter.md index 286f090b..9473a2ef 100644 --- a/en/api/@connectum/events/types/interfaces/EventRouter.md +++ b/en/api/@connectum/events/types/interfaces/EventRouter.md @@ -2,7 +2,7 @@ # Interface: EventRouter -Defined in: [packages/events/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L214) +Defined in: [packages/events/src/types.ts:229](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L229) Event router for registering service event handlers. @@ -15,7 +15,7 @@ Mirrors ConnectRPC's ConnectRouter pattern: > **service**\<`S`\>(`serviceDesc`, `handlers`): `void` -Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L216) +Defined in: [packages/events/src/types.ts:231](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L231) Register event handlers for a service diff --git a/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md b/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md index b819cff8..1e92fa74 100644 --- a/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md +++ b/en/api/@connectum/events/types/interfaces/MiddlewareConfig.md @@ -2,7 +2,7 @@ # Interface: MiddlewareConfig -Defined in: [packages/events/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L282) +Defined in: [packages/events/src/types.ts:297](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L297) Built-in middleware configuration @@ -12,7 +12,7 @@ Built-in middleware configuration > `optional` **custom?**: [`EventMiddleware`](../type-aliases/EventMiddleware.md)[] -Defined in: [packages/events/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L288) +Defined in: [packages/events/src/types.ts:303](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L303) Custom user middleware (executed outermost) @@ -22,7 +22,7 @@ Custom user middleware (executed outermost) > `optional` **dlq?**: [`DlqOptions`](DlqOptions.md) -Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L286) +Defined in: [packages/events/src/types.ts:301](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L301) Dead letter queue configuration @@ -32,6 +32,6 @@ Dead letter queue configuration > `optional` **retry?**: [`RetryOptions`](RetryOptions.md) -Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L284) +Defined in: [packages/events/src/types.ts:299](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L299) Retry configuration diff --git a/en/api/@connectum/events/types/interfaces/PublishOptions.md b/en/api/@connectum/events/types/interfaces/PublishOptions.md index 4318e71c..db21d52c 100644 --- a/en/api/@connectum/events/types/interfaces/PublishOptions.md +++ b/en/api/@connectum/events/types/interfaces/PublishOptions.md @@ -28,6 +28,20 @@ Message key for partitioning (Kafka: partition key, others: ignored) *** +### messageId? + +> `optional` **messageId?**: `string` + +Defined in: [packages/events/src/types.ts:75](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L75) + +Caller-supplied message identifier the adapter sets on the wire where +supported (AMQP: the `messageId` property; other adapters ignore it). +Primarily for external-contract publishing — in `@connectum/events-amqp` +`externalContract` mode the adapter does not auto-generate a `messageId`, +so set this when the contract requires one. + +*** + ### metadata? > `optional` **metadata?**: `Record`\<`string`, `string`\> @@ -38,6 +52,19 @@ Additional metadata / headers *** +### timestamp? + +> `optional` **timestamp?**: `number` + +Defined in: [packages/events/src/types.ts:82](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L82) + +Caller-supplied message timestamp in **Unix epoch seconds**, set on the +wire where supported (AMQP: the `timestamp` property; other adapters +ignore it). Like [messageId](#messageid), mainly for external-contract +publishing where the adapter does not auto-populate it. + +*** + ### topic? > `optional` **topic?**: `string` diff --git a/en/api/@connectum/events/types/interfaces/RetryOptions.md b/en/api/@connectum/events/types/interfaces/RetryOptions.md index 9122dcb3..a135e0ea 100644 --- a/en/api/@connectum/events/types/interfaces/RetryOptions.md +++ b/en/api/@connectum/events/types/interfaces/RetryOptions.md @@ -2,7 +2,7 @@ # Interface: RetryOptions -Defined in: [packages/events/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L249) +Defined in: [packages/events/src/types.ts:264](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L264) Retry middleware options @@ -12,7 +12,7 @@ Retry middleware options > `optional` **backoff?**: `"fixed"` \| `"exponential"` \| `"linear"` -Defined in: [packages/events/src/types.ts:253](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L253) +Defined in: [packages/events/src/types.ts:268](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L268) Backoff strategy @@ -22,7 +22,7 @@ Backoff strategy > `optional` **initialDelay?**: `number` -Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L255) +Defined in: [packages/events/src/types.ts:270](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L270) Initial delay in ms (default: 1000) @@ -32,7 +32,7 @@ Initial delay in ms (default: 1000) > `optional` **maxDelay?**: `number` -Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L257) +Defined in: [packages/events/src/types.ts:272](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L272) Maximum delay in ms (default: 30000) @@ -42,7 +42,7 @@ Maximum delay in ms (default: 30000) > `optional` **maxRetries?**: `number` -Defined in: [packages/events/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L251) +Defined in: [packages/events/src/types.ts:266](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L266) Maximum retry attempts (default: 3) @@ -52,7 +52,7 @@ Maximum retry attempts (default: 3) > `optional` **multiplier?**: `number` -Defined in: [packages/events/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L259) +Defined in: [packages/events/src/types.ts:274](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L274) Multiplier for exponential backoff (default: 2) @@ -62,7 +62,7 @@ Multiplier for exponential backoff (default: 2) > `optional` **retryableErrors?**: (`error`) => `boolean` -Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L261) +Defined in: [packages/events/src/types.ts:276](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L276) Filter: only retry for these error types diff --git a/en/api/@connectum/events/types/type-aliases/EventMiddleware.md b/en/api/@connectum/events/types/type-aliases/EventMiddleware.md index c1a0672e..86bde814 100644 --- a/en/api/@connectum/events/types/type-aliases/EventMiddleware.md +++ b/en/api/@connectum/events/types/type-aliases/EventMiddleware.md @@ -4,7 +4,7 @@ > **EventMiddleware** = (`event`, `ctx`, `next`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:240](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L240) +Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L255) Event middleware function diff --git a/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md b/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md index 69aef3aa..2e4b5c8b 100644 --- a/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md +++ b/en/api/@connectum/events/types/type-aliases/EventMiddlewareNext.md @@ -4,7 +4,7 @@ > **EventMiddlewareNext** = (`updatedEvent?`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L235) +Defined in: [packages/events/src/types.ts:250](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L250) Event middleware next function. diff --git a/en/api/@connectum/events/types/type-aliases/EventRoute.md b/en/api/@connectum/events/types/type-aliases/EventRoute.md index a98a8a11..1a60d6ec 100644 --- a/en/api/@connectum/events/types/type-aliases/EventRoute.md +++ b/en/api/@connectum/events/types/type-aliases/EventRoute.md @@ -4,7 +4,7 @@ > **EventRoute** = (`events`) => `void` -Defined in: [packages/events/src/types.ts:222](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L222) +Defined in: [packages/events/src/types.ts:237](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L237) Event route function -- mirrors ServiceRoute from @connectum/core diff --git a/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md b/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md index 180f6403..7acbdb80 100644 --- a/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md +++ b/en/api/@connectum/events/types/type-aliases/ServiceEventHandlers.md @@ -4,7 +4,7 @@ > **ServiceEventHandlers**\<`S`\> = \{ \[K in keyof S\["method"\]\]: TypedEventHandler\\> \| EventHandlerConfig\\> \} -Defined in: [packages/events/src/types.ts:190](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L190) +Defined in: [packages/events/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L205) Maps service methods to typed event handlers. diff --git a/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md b/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md index 0942cead..5681d284 100644 --- a/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md +++ b/en/api/@connectum/events/types/type-aliases/TypedEventHandler.md @@ -4,7 +4,7 @@ > **TypedEventHandler**\<`I`\> = (`event`, `ctx`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:167](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L167) +Defined in: [packages/events/src/types.ts:182](https://github.com/Connectum-Framework/connectum/blob/main/packages/events/src/types.ts#L182) Typed event handler for a specific message type diff --git a/en/packages/events-amqp.md b/en/packages/events-amqp.md index 44322ae3..8aceed52 100644 --- a/en/packages/events-amqp.md +++ b/en/packages/events-amqp.md @@ -117,6 +117,7 @@ Pass the result to `createEventBus({ adapter })`. | `persistent` | `boolean` | `true` | Mark messages as persistent (`deliveryMode: 2`). Messages survive broker restarts when the queue is durable | | `mandatory` | `boolean` | `false` | Reject the publish with `AmqpUnroutableError` when the broker cannot route the message to any queue | | `correlationHeader` | `boolean` | `true` | Correlate `basic.return` frames to mandatory publishes via a private `x-connectum-publish-id` header (visible on the wire); `false` switches to single-flight serialization of mandatory publishes | +| `externalContract` | `boolean` | `false` | Publish against an external (non-EventBus) contract: suppress the EventBus envelope so the frame carries only contract-specified properties — no `x-event-id` / `x-published-at` headers, no auto `messageId` / `timestamp`, and `mandatory` uses single-flight correlation (so no `x-connectum-publish-id` reaches the wire; `correlationHeader` is ignored). The frame then carries only `contentType`, `persistent`, `mandatory`, and the headers passed via `PublishOptions.metadata`. Set a contract-required `messageId` / `timestamp` per-publish via `PublishOptions`. Available since 1.1.0. | ### `AmqpSerializationOptions` @@ -323,7 +324,10 @@ const adapter = AmqpAdapter({ queueOverrides: { partner: { queue: 'partner.inbound.v1' }, }, - publisherOptions: { persistent: true, mandatory: true }, + // externalContract: emit ONLY contract-specified properties -- suppress the + // EventBus envelope (no x-event-id / x-published-at, no auto messageId / + // timestamp, no x-connectum-publish-id). Available since 1.1.0. + publisherOptions: { persistent: true, mandatory: true, externalContract: true }, }); await adapter.connect(); @@ -345,8 +349,10 @@ const body = new TextEncoder().encode(JSON.stringify({ code: '0104603...' })); await adapter.publish('inbound', body); ``` -::: warning Wire-visible correlation header -With `mandatory: true` and the default `correlationHeader: true`, every mandatory publish carries a private `x-connectum-publish-id` header that external consumers will see. Either document the header in the contract, or set `publisherOptions.correlationHeader: false` for a clean wire -- mandatory publishes are then serialized single-flight (throughput trade-off). +::: tip Keeping the external wire contract-pure +`externalContract: true` (set above) is what keeps the frame contract-only: it suppresses the EventBus envelope (`x-event-id` / `x-published-at`), skips the auto `messageId` / `timestamp`, and serializes `mandatory` publishes single-flight so no private `x-connectum-publish-id` header reaches the wire (`correlationHeader` is ignored in this mode). The frame then carries only `contentType`, `persistent`, `mandatory`, and the headers you pass via `PublishOptions.metadata`; set a contract-required `messageId` / `timestamp` per-publish via [`PublishOptions`](/en/packages/events#publishoptions). + +Without `externalContract`, a `mandatory` publish at the default `correlationHeader: true` carries the wire-visible `x-connectum-publish-id` header (setting `correlationHeader: false` removes only that header -- the envelope headers are still stamped). Prefer `externalContract` for a genuinely contract-only wire. Available since 1.1.0. ::: ## Reliable Publishing diff --git a/en/packages/events.md b/en/packages/events.md index e84a951c..56398a93 100644 --- a/en/packages/events.md +++ b/en/packages/events.md @@ -154,6 +154,8 @@ function createEventBus(options: EventBusOptions): EventBus & EventBusLike; | `key` | `string` | `undefined` | Partition/routing key for ordered delivery | | `group` | `string` | `undefined` | Named group tag for workflow grouping | | `metadata` | `Record` | `undefined` | Additional metadata / headers | +| `messageId` | `string` | `undefined` | Caller-supplied message id the adapter sets on the wire where supported (AMQP `messageId` property; other adapters ignore it). Mainly for external-contract publishing, where the adapter does not auto-generate one. Available since 1.1.0. | +| `timestamp` | `number` | `undefined` | Caller-supplied message timestamp in Unix epoch seconds, set on the wire where supported (AMQP `timestamp` property; other adapters ignore it). Mainly for external-contract publishing. Available since 1.1.0. | ### `EventContext`