From 7b00f8c2092a704167d13ac56f45c4bdce05be47 Mon Sep 17 00:00:00 2001 From: intech Date: Tue, 5 May 2026 00:49:06 +0400 Subject: [PATCH 1/4] chore(deps): migrate to pnpm 11.0.4 Migrate package manager from pnpm 10.23.0 to pnpm 11.0.4 (stable). Changes: - package.json: bump packageManager; remove pnpm field (pnpm 11 no longer reads it from package.json) - pnpm-workspace.yaml (new): move overrides (3 rules: lodash-es, rollup, minimatch) and replace onlyBuiltDependencies with allowBuilds map (esbuild) - pnpm-lock.yaml: regenerate under pnpm 11 (lockfileVersion 9.0 retained) Tested locally: - pnpm install: clean, no warnings - pnpm docs:build: VitePress build complete (109s, all API md files processed) Co-Authored-By: Claude Opus 4.7 (1M context) --- package.json | 12 +- pnpm-lock.yaml | 539 +++++++++++++++++++++++--------------------- pnpm-workspace.yaml | 7 + 3 files changed, 284 insertions(+), 274 deletions(-) create mode 100644 pnpm-workspace.yaml diff --git a/package.json b/package.json index 4189eaa..97c1b98 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "docs:build": "vitepress build", "docs:preview": "vitepress preview" }, - "packageManager": "pnpm@10.23.0", + "packageManager": "pnpm@11.0.4", "devDependencies": { "@braintree/sanitize-url": "^7.1.2", "cytoscape": "^3.33.2", @@ -19,16 +19,6 @@ "vitepress-plugin-llms": "^1.12.1", "vitepress-plugin-mermaid": "^2.0.17" }, - "pnpm": { - "overrides": { - "lodash-es@<=4.17.23": ">=4.18.0", - "rollup@>=4.0.0 <4.59.0": "4.59.0", - "minimatch@>=10.0.0 <10.2.3": "10.2.3" - }, - "onlyBuiltDependencies": [ - "esbuild" - ] - }, "dependencies": { "medium-zoom": "^1.1.0" } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 612bad4..f05b7bd 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -22,10 +22,10 @@ importers: version: 7.1.2 cytoscape: specifier: ^3.33.2 - version: 3.33.2 + version: 3.33.3 cytoscape-cose-bilkent: specifier: ^4.1.0 - version: 4.1.0(cytoscape@3.33.2) + version: 4.1.0(cytoscape@3.33.3) dayjs: specifier: ^1.11.20 version: 1.11.20 @@ -37,18 +37,18 @@ importers: version: 11.14.0 vitepress: specifier: ^1.6.3 - version: 1.6.4(@algolia/client-search@5.48.0)(postcss@8.5.6)(search-insights@2.17.3) + version: 1.6.4(@algolia/client-search@5.52.0)(postcss@8.5.13)(search-insights@2.17.3) vitepress-plugin-llms: specifier: ^1.12.1 - version: 1.12.1 + version: 1.12.2 vitepress-plugin-mermaid: specifier: ^2.0.17 - version: 2.0.17(mermaid@11.14.0)(vitepress@1.6.4(@algolia/client-search@5.48.0)(postcss@8.5.6)(search-insights@2.17.3)) + version: 2.0.17(mermaid@11.14.0)(vitepress@1.6.4(@algolia/client-search@5.52.0)(postcss@8.5.13)(search-insights@2.17.3)) packages: - '@algolia/abtesting@1.14.0': - resolution: {integrity: sha512-cZfj+1Z1dgrk3YPtNQNt0H9Rr67P8b4M79JjUKGS0d7/EbFbGxGgSu6zby5f22KXo3LT0LZa4O2c6VVbupJuDg==} + '@algolia/abtesting@1.18.0': + resolution: {integrity: sha512-8siuLG+FIns1AjZ/g2SDVwHz9S+ObacDQISEJvS8XsNei1zl3FXqfqQrBpmrG7ACWCyesXHbicMJtvRbg00FEw==} engines: {node: '>= 14.0.0'} '@algolia/autocomplete-core@1.17.7': @@ -71,56 +71,56 @@ packages: '@algolia/client-search': '>= 4.9.1 < 6' algoliasearch: '>= 4.9.1 < 6' - '@algolia/client-abtesting@5.48.0': - resolution: {integrity: sha512-n17WSJ7vazmM6yDkWBAjY12J8ERkW9toOqNgQ1GEZu/Kc4dJDJod1iy+QP5T/UlR3WICgZDi/7a/VX5TY5LAPQ==} + '@algolia/client-abtesting@5.52.0': + resolution: {integrity: sha512-wtwPgyPmO7b7sQPVgoK29c1VpfS08DnnJCmxX/oU1pV2DlMRJCzQcLN7JSloYpodyKHwM8+9wOzlAM0co3TDmA==} engines: {node: '>= 14.0.0'} - '@algolia/client-analytics@5.48.0': - resolution: {integrity: sha512-v5bMZMEqW9U2l40/tTAaRyn4AKrYLio7KcRuHmLaJtxuJAhvZiE7Y62XIsF070juz4MN3eyvfQmI+y5+OVbZuA==} + '@algolia/client-analytics@5.52.0': + resolution: {integrity: sha512-9KY36bRl4AH7RjqSeDDOKnjsz4IxQFBEOB8/fWmEbdQe+Isbs5jGzVJu9NEPQ1Tgwxlf8Uf07Swj3jZyMNUZ2g==} engines: {node: '>= 14.0.0'} - '@algolia/client-common@5.48.0': - resolution: {integrity: sha512-7H3DgRyi7UByScc0wz7EMrhgNl7fKPDjKX9OcWixLwCj7yrRXDSIzwunykuYUUO7V7HD4s319e15FlJ9CQIIFQ==} + '@algolia/client-common@5.52.0': + resolution: {integrity: sha512-3a/qM3dzJqqfTx7Yrw7uGQ98I3Q0rDfb4Vkv0wEzko96l7YQMxfBVz/VbLq2N+c59GweYv6Vhp8mPeqnWJSITw==} engines: {node: '>= 14.0.0'} - '@algolia/client-insights@5.48.0': - resolution: {integrity: sha512-tXmkB6qrIGAXrtRYHQNpfW0ekru/qymV02bjT0w5QGaGw0W91yT+53WB6dTtRRsIrgS30Al6efBvyaEosjZ5uw==} + '@algolia/client-insights@5.52.0': + resolution: {integrity: sha512-Rki7ACbMcvbQW0BuM84x9dkGHY47ABmv4jU6tYssat2k02p3mIUms2YOLUAMeknhmnFsj6lb6ZzOXdMWMyc1sA==} engines: {node: '>= 14.0.0'} - '@algolia/client-personalization@5.48.0': - resolution: {integrity: sha512-4tXEsrdtcBZbDF73u14Kb3otN+xUdTVGop1tBjict+Rc/FhsJQVIwJIcTrOJqmvhtBfc56Bu65FiVOnpAZCxcw==} + '@algolia/client-personalization@5.52.0': + resolution: {integrity: sha512-96s4Uzc3kk+/f4jJXIVVGWP5XlngOGNQ1x6hW9AT59pOixHlOs5tqJg+ZUS/GQ6h/iYP0ceQcmxDQeLyCLTaDQ==} engines: {node: '>= 14.0.0'} - '@algolia/client-query-suggestions@5.48.0': - resolution: {integrity: sha512-unzSUwWFpsDrO8935RhMAlyK0Ttua/5XveVIwzfjs5w+GVBsHgIkbOe8VbBJccMU/z1LCwvu1AY3kffuSLAR5Q==} + '@algolia/client-query-suggestions@5.52.0': + resolution: {integrity: sha512-lqeycNpSPe5Qa0OUWpejVvYQjQWV5nQuLT0a4aq7XzRAvCxprV/6Lf841EygdD2nrFnuS58ok7Au1uOtXzpnkg==} engines: {node: '>= 14.0.0'} - '@algolia/client-search@5.48.0': - resolution: {integrity: sha512-RB9bKgYTVUiOcEb5bOcZ169jiiVW811dCsJoLT19DcbbFmU4QaK0ghSTssij35QBQ3SCOitXOUrHcGgNVwS7sQ==} + '@algolia/client-search@5.52.0': + resolution: {integrity: sha512-ly1wETVGRo30cx61O7fetESN+ElL9c9K+bD/AVgnT1ar4c6v+/Yqjrhdtu6Fm4D0s4NZP081Isf6tunH1wUXHg==} engines: {node: '>= 14.0.0'} - '@algolia/ingestion@1.48.0': - resolution: {integrity: sha512-rhoSoPu+TDzDpvpk3cY/pYgbeWXr23DxnAIH/AkN0dUC+GCnVIeNSQkLaJ+CL4NZ51cjLIjksrzb4KC5Xu+ktw==} + '@algolia/ingestion@1.52.0': + resolution: {integrity: sha512-U4EeTvgmluRjj39ykZSAd5X+a6LD5m7/mcOWDmB7hqm1R6QY0yT8jLxpNVEjYhzgEN5hcDGW6X67EWQY8KiYGQ==} engines: {node: '>= 14.0.0'} - '@algolia/monitoring@1.48.0': - resolution: {integrity: sha512-aSe6jKvWt+8VdjOaq2ERtsXp9+qMXNJ3mTyTc1VMhNfgPl7ArOhRMRSQ8QBnY8ZL4yV5Xpezb7lAg8pdGrrulg==} + '@algolia/monitoring@1.52.0': + resolution: {integrity: sha512-FCPnDcILfpTE94u7BVlV4DmnSV5wE3+j25EEF+3dYPrVzkVCSoAHs318oWDGxnxsAgiL4HpL12Jc4XHmw9shpA==} engines: {node: '>= 14.0.0'} - '@algolia/recommend@5.48.0': - resolution: {integrity: sha512-p9tfI1bimAaZrdiVExL/dDyGUZ8gyiSHsktP1ZWGzt5hXpM3nhv4tSjyHtXjEKtA0UvsaHKwSfFE8aAAm1eIQA==} + '@algolia/recommend@5.52.0': + resolution: {integrity: sha512-br3DO7n4N8CXwTRbZS0MnB4WQ9YHfNjCwkCEzVR/wek/qNTDQKDb0nROmkFaNZ8ucUqUVKZi074dbwMwRDlK8Q==} engines: {node: '>= 14.0.0'} - '@algolia/requester-browser-xhr@5.48.0': - resolution: {integrity: sha512-XshyfpsQB7BLnHseMinp3fVHOGlTv6uEHOzNK/3XrEF9mjxoZAcdVfY1OCXObfwRWX5qXZOq8FnrndFd44iVsQ==} + '@algolia/requester-browser-xhr@5.52.0': + resolution: {integrity: sha512-b0T/Ca2c9KyEslKsVrGZvbe1UrrKKSdfXhBZ2pbpKahFUzJfziRZ0urbOm7V65O0tO/jwU+Lo/+bIiiyhzGt8w==} engines: {node: '>= 14.0.0'} - '@algolia/requester-fetch@5.48.0': - resolution: {integrity: sha512-Q4XNSVQU89bKNAPuvzSYqTH9AcbOOiIo6AeYMQTxgSJ2+uvT78CLPMG89RIIloYuAtSfE07s40OLV50++l1Bbw==} + '@algolia/requester-fetch@5.52.0': + resolution: {integrity: sha512-ozBT8J/mtD4H4IAojw8QPirlcL2gHrI1BGuZ4/ZXXO/rTE1yQ4VIPJj4mTTbwo4FbkS1MoJsD/DsrqLzhnc4/g==} engines: {node: '>= 14.0.0'} - '@algolia/requester-node-http@5.48.0': - resolution: {integrity: sha512-ZgxV2+5qt3NLeUYBTsi6PLyHcENQWC0iFppFZekHSEDA2wcLdTUjnaJzimTEULHIvJuLRCkUs4JABdhuJktEag==} + '@algolia/requester-node-http@5.52.0': + resolution: {integrity: sha512-gyyWcLD22tnabmoit4iukCXuoRc5HYJuUjPSEa8a0D/f/NlRafpWi52AlAaa4Uu/rsl7saHsJFTNjTptWbu2+A==} engines: {node: '>= 14.0.0'} '@antfu/install-pkg@1.1.0': @@ -134,8 +134,8 @@ packages: resolution: {integrity: sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==} engines: {node: '>=6.9.0'} - '@babel/parser@7.29.0': - resolution: {integrity: sha512-IyDgFV5GeDUVX4YdF/3CPULtVGSXXMLh1xVIgdCgxApktqnQV0r7/8Nqthg+8YLGaAtdyIlo2qIdZrbCv4+7ww==} + '@babel/parser@7.29.3': + resolution: {integrity: sha512-b3ctpQwp+PROvU/cttc4OYl4MzfJUWy6FZg+PMXfzmt/+39iHVF0sDfqay8TQM3JA2EUOyKcFZt75jWriQijsA==} engines: {node: '>=6.0.0'} hasBin: true @@ -325,14 +325,14 @@ packages: cpu: [x64] os: [win32] - '@iconify-json/simple-icons@1.2.70': - resolution: {integrity: sha512-CYNRCgN6nBTjN4dNkrBCjHXNR2e4hQihdsZUs/afUNFOWLSYjfihca4EFN05rRvDk4Xoy2n8tym6IxBZmcn+Qg==} + '@iconify-json/simple-icons@1.2.80': + resolution: {integrity: sha512-iglncJJ6X/dVuzFDU32MrHwwo4RBwivGf108dgyYg+HKS78ifx0h7sTenpDZMVT+UhdS6CSgZcvY/SvRXlIEUg==} '@iconify/types@2.0.0': resolution: {integrity: sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==} - '@iconify/utils@3.1.0': - resolution: {integrity: sha512-Zlzem1ZXhI1iHeeERabLNzBHdOa4VhQbqAcOQaMKuTuyZCpwKbC2R4Dd0Zo3g9EAc+Y4fiarO8HIHRAth7+skw==} + '@iconify/utils@3.1.1': + resolution: {integrity: sha512-MwzoDtw9rO1x+qfgLTV/IVXsHDBqeYZoMIQC8SfxfYSlaSUG+oWiAcoiB1yajAda6mqblm4/1/w2E8tRu7a7Tw==} '@jridgewell/sourcemap-codec@1.5.5': resolution: {integrity: sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==} @@ -377,66 +377,79 @@ packages: resolution: {integrity: sha512-t4ONHboXi/3E0rT6OZl1pKbl2Vgxf9vJfWgmUoCEVQVxhW6Cw/c8I6hbbu7DAvgp82RKiH7TpLwxnJeKv2pbsw==} cpu: [arm] os: [linux] + libc: [glibc] '@rollup/rollup-linux-arm-musleabihf@4.59.0': resolution: {integrity: sha512-CikFT7aYPA2ufMD086cVORBYGHffBo4K8MQ4uPS/ZnY54GKj36i196u8U+aDVT2LX4eSMbyHtyOh7D7Zvk2VvA==} cpu: [arm] os: [linux] + libc: [musl] '@rollup/rollup-linux-arm64-gnu@4.59.0': resolution: {integrity: sha512-jYgUGk5aLd1nUb1CtQ8E+t5JhLc9x5WdBKew9ZgAXg7DBk0ZHErLHdXM24rfX+bKrFe+Xp5YuJo54I5HFjGDAA==} cpu: [arm64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-arm64-musl@4.59.0': resolution: {integrity: sha512-peZRVEdnFWZ5Bh2KeumKG9ty7aCXzzEsHShOZEFiCQlDEepP1dpUl/SrUNXNg13UmZl+gzVDPsiCwnV1uI0RUA==} cpu: [arm64] os: [linux] + libc: [musl] '@rollup/rollup-linux-loong64-gnu@4.59.0': resolution: {integrity: sha512-gbUSW/97f7+r4gHy3Jlup8zDG190AuodsWnNiXErp9mT90iCy9NKKU0Xwx5k8VlRAIV2uU9CsMnEFg/xXaOfXg==} cpu: [loong64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-loong64-musl@4.59.0': resolution: {integrity: sha512-yTRONe79E+o0FWFijasoTjtzG9EBedFXJMl888NBEDCDV9I2wGbFFfJQQe63OijbFCUZqxpHz1GzpbtSFikJ4Q==} cpu: [loong64] os: [linux] + libc: [musl] '@rollup/rollup-linux-ppc64-gnu@4.59.0': resolution: {integrity: sha512-sw1o3tfyk12k3OEpRddF68a1unZ5VCN7zoTNtSn2KndUE+ea3m3ROOKRCZxEpmT9nsGnogpFP9x6mnLTCaoLkA==} cpu: [ppc64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-ppc64-musl@4.59.0': resolution: {integrity: sha512-+2kLtQ4xT3AiIxkzFVFXfsmlZiG5FXYW7ZyIIvGA7Bdeuh9Z0aN4hVyXS/G1E9bTP/vqszNIN/pUKCk/BTHsKA==} cpu: [ppc64] os: [linux] + libc: [musl] '@rollup/rollup-linux-riscv64-gnu@4.59.0': resolution: {integrity: sha512-NDYMpsXYJJaj+I7UdwIuHHNxXZ/b/N2hR15NyH3m2qAtb/hHPA4g4SuuvrdxetTdndfj9b1WOmy73kcPRoERUg==} cpu: [riscv64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-riscv64-musl@4.59.0': resolution: {integrity: sha512-nLckB8WOqHIf1bhymk+oHxvM9D3tyPndZH8i8+35p/1YiVoVswPid2yLzgX7ZJP0KQvnkhM4H6QZ5m0LzbyIAg==} cpu: [riscv64] os: [linux] + libc: [musl] '@rollup/rollup-linux-s390x-gnu@4.59.0': resolution: {integrity: sha512-oF87Ie3uAIvORFBpwnCvUzdeYUqi2wY6jRFWJAy1qus/udHFYIkplYRW+wo+GRUP4sKzYdmE1Y3+rY5Gc4ZO+w==} cpu: [s390x] os: [linux] + libc: [glibc] '@rollup/rollup-linux-x64-gnu@4.59.0': resolution: {integrity: sha512-3AHmtQq/ppNuUspKAlvA8HtLybkDflkMuLK4DPo77DfthRb71V84/c4MlWJXixZz4uruIH4uaa07IqoAkG64fg==} cpu: [x64] os: [linux] + libc: [glibc] '@rollup/rollup-linux-x64-musl@4.59.0': resolution: {integrity: sha512-2UdiwS/9cTAx7qIUZB/fWtToJwvt0Vbo0zmnYt7ED35KPg13Q0ym1g442THLC7VyI6JfYTP4PiSOWyoMdV2/xg==} cpu: [x64] os: [linux] + libc: [musl] '@rollup/rollup-openbsd-x64@4.59.0': resolution: {integrity: sha512-M3bLRAVk6GOwFlPTIxVBSYKUaqfLrn8l0psKinkCFxl4lQvOSz8ZrKDz2gxcBwHFpci0B6rttydI4IpS4IS/jQ==} @@ -634,17 +647,17 @@ packages: vite: ^5.0.0 || ^6.0.0 vue: ^3.2.25 - '@vue/compiler-core@3.5.28': - resolution: {integrity: sha512-kviccYxTgoE8n6OCw96BNdYlBg2GOWfBuOW4Vqwrt7mSKWKwFVvI8egdTltqRgITGPsTFYtKYfxIG8ptX2PJHQ==} + '@vue/compiler-core@3.5.33': + resolution: {integrity: sha512-3PZLQwFw4Za3TC8t0FvTy3wI16Kt+pmwcgNZca4Pj9iWL2E72a/gZlpBtAJvEdDMdCxdG/qq0C7PN0bsJuv0Rw==} - '@vue/compiler-dom@3.5.28': - resolution: {integrity: sha512-/1ZepxAb159jKR1btkefDP+J2xuWL5V3WtleRmxaT+K2Aqiek/Ab/+Ebrw2pPj0sdHO8ViAyyJWfhXXOP/+LQA==} + '@vue/compiler-dom@3.5.33': + resolution: {integrity: sha512-PXq0yrfCLzzL07rbXO4awtXY1Z06LG2eu6Adg3RJFa/j3Cii217XxxLXG22N330gw7GmALCY0Z8RgXEviwgpjA==} - '@vue/compiler-sfc@3.5.28': - resolution: {integrity: sha512-6TnKMiNkd6u6VeVDhZn/07KhEZuBSn43Wd2No5zaP5s3xm8IqFTHBj84HJah4UepSUJTro5SoqqlOY22FKY96g==} + '@vue/compiler-sfc@3.5.33': + resolution: {integrity: sha512-UTUvRO9cY+rROrx/pvN9P5Z7FgA6QGfokUCfhQE4EnmUj3rVnK+CHI0LsEO1pg+I7//iRYMUfcNcCPe7tg0CoA==} - '@vue/compiler-ssr@3.5.28': - resolution: {integrity: sha512-JCq//9w1qmC6UGLWJX7RXzrGpKkroubey/ZFqTpvEIDJEKGgntuDMqkuWiZvzTzTA5h2qZvFBFHY7fAAa9475g==} + '@vue/compiler-ssr@3.5.33': + resolution: {integrity: sha512-IErjYdnj1qIupG5xxiVIYiiRvDhGWV4zuh/RCrwfYpuL+HWQzeU6lCk/nF9r7olWMnjKxCAkOctT2qFWFkzb1A==} '@vue/devtools-api@7.7.9': resolution: {integrity: sha512-kIE8wvwlcZ6TJTbNeU2HQNtaxLx3a84aotTITUuL/4bzfPxzajGBOoqjMhwZJ8L9qFYDU/lAYMEEm11dnZOD6g==} @@ -655,22 +668,22 @@ packages: '@vue/devtools-shared@7.7.9': resolution: {integrity: sha512-iWAb0v2WYf0QWmxCGy0seZNDPdO3Sp5+u78ORnyeonS6MT4PC7VPrryX2BpMJrwlDeaZ6BD4vP4XKjK0SZqaeA==} - '@vue/reactivity@3.5.28': - resolution: {integrity: sha512-gr5hEsxvn+RNyu9/9o1WtdYdwDjg5FgjUSBEkZWqgTKlo/fvwZ2+8W6AfKsc9YN2k/+iHYdS9vZYAhpi10kNaw==} + '@vue/reactivity@3.5.33': + resolution: {integrity: sha512-p8UfIqyIhb0rYGlSgSBV+lPhF2iUSBcRy7enhTmPqKWadHy9kcOFYF1AejYBP9P+avnd3OBbD49DU4pLWX/94A==} - '@vue/runtime-core@3.5.28': - resolution: {integrity: sha512-POVHTdbgnrBBIpnbYU4y7pOMNlPn2QVxVzkvEA2pEgvzbelQq4ZOUxbp2oiyo+BOtiYlm8Q44wShHJoBvDPAjQ==} + '@vue/runtime-core@3.5.33': + resolution: {integrity: sha512-UpFF45RI9//a7rvq7RdOQblb4tup7hHG9QsmIrxkFQLzQ7R8/iNQ5LE15NhLZ1/WcHMU2b47u6P33CPUelHyIQ==} - '@vue/runtime-dom@3.5.28': - resolution: {integrity: sha512-4SXxSF8SXYMuhAIkT+eBRqOkWEfPu6nhccrzrkioA6l0boiq7sp18HCOov9qWJA5HML61kW8p/cB4MmBiG9dSA==} + '@vue/runtime-dom@3.5.33': + resolution: {integrity: sha512-IOxMsAOwquhfITgmOgaPYl7/j8gKUxUFoflRc+u4LxyD3+783xne8vNta1PONVCvCV9A0w7hkyEepINDqfO0tw==} - '@vue/server-renderer@3.5.28': - resolution: {integrity: sha512-pf+5ECKGj8fX95bNincbzJ6yp6nyzuLDhYZCeFxUNp8EBrQpPpQaLX3nNCp49+UbgbPun3CeVE+5CXVV1Xydfg==} + '@vue/server-renderer@3.5.33': + resolution: {integrity: sha512-0xylq/8/h44lVG0pZFknv1XIdEgymq2E9n59uTWJBG+dIgiT0TMCSsxrN7nO16Z0MU0MPjFcguBbZV8Itk52Hw==} peerDependencies: - vue: 3.5.28 + vue: 3.5.33 - '@vue/shared@3.5.28': - resolution: {integrity: sha512-cfWa1fCGBxrvaHRhvV3Is0MgmrbSCxYTXCSCau2I0a1Xw1N1pHAvkWCiXPRAqjvToILvguNyEwjevUqAuBQWvQ==} + '@vue/shared@3.5.33': + resolution: {integrity: sha512-5vR2QIlmaLG77Ygd4pMP6+SGQ5yox9VhtnbDWTy9DzMzdmeLxZ1QqxrywEZ9sa1AVubfIJyaCG3ytyWU81ufcQ==} '@vueuse/core@12.8.2': resolution: {integrity: sha512-HbvCmZdzAu3VGi/pWYm5Ut+Kd9mn1ZHnn4L5G8kOQTPs/IwIAmJoBrmYk2ckLArgMXZj0AW3n5CAejLUO+PhdQ==} @@ -727,8 +740,8 @@ packages: engines: {node: '>=0.4.0'} hasBin: true - algoliasearch@5.48.0: - resolution: {integrity: sha512-aD8EQC6KEman6/S79FtPdQmB7D4af/etcRL/KwiKFKgAE62iU8c5PeEQvpvIcBPurC3O/4Lj78nOl7ZcoazqSw==} + algoliasearch@5.52.0: + resolution: {integrity: sha512-0ZzY9mjqV7gop/AH8pIBiAS8giXP7WcSiUfoFYIzYAK9QC5c37E4SIVtJVBMwlURc0/uNt2o4RcNRvdHa4CJ5w==} engines: {node: '>= 14.0.0'} ansi-regex@5.0.1: @@ -771,8 +784,8 @@ packages: character-entities@2.0.2: resolution: {integrity: sha512-shx7oQ0Awen/BRIdkjkvz54PnEEI/EjwXDSIZp86/KKdbafHh1Df/RYGBhn4hbe2+uKC9FnT5UCEdyPz3ai9hQ==} - chevrotain-allstar@0.4.1: - resolution: {integrity: sha512-PvVJm3oGqrveUVW2Vt/eZGeiAIsJszYweUcYwcskg9e+IubNYKKD+rHHem7A6XVO22eDAL+inxNIGAzZ/VIWlA==} + chevrotain-allstar@0.4.3: + resolution: {integrity: sha512-2X4mkroolSMKqW+H22pyPMUVDqYZzPhephTmg/NODKb1IGYPHfxfhcW0EjS7wcPJNbze2i4vBWT7zT5FKF2lrQ==} peerDependencies: chevrotain: ^12.0.0 @@ -828,8 +841,8 @@ packages: peerDependencies: cytoscape: ^3.2.0 - cytoscape@3.33.2: - resolution: {integrity: sha512-sj4HXd3DokGhzZAdjDejGvTPLqlt84vNFN8m7bGsOzDY5DyVcxIb2ejIXat2Iy7HxWhdT/N1oKyheJ5YdpsGuw==} + cytoscape@3.33.3: + resolution: {integrity: sha512-Gej7U+OKR+LZ8kvX7rb2HhCYJ0IhvEFsnkud4SB1PR+BUY/TsSO0dmOW59WEVLu51b1Rm+gQRKoz4bLYxGSZ2g==} engines: {node: '>=0.10'} d3-array@2.12.1: @@ -999,8 +1012,8 @@ packages: devlop@1.1.0: resolution: {integrity: sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==} - dompurify@3.4.0: - resolution: {integrity: sha512-nolgK9JcaUXMSmW+j1yaSvaEaoXYHwWyGJlkoCTghc97KgGDDSnpoU/PlEnw63Ah+TGKFOyY+X5LnxaWbCSfXg==} + dompurify@3.4.2: + resolution: {integrity: sha512-lHeS9SA/IKeIFFyYciHBr2n0v1VMPlSj843HdLOwjb2OxNwdq9Xykxqhk+FE42MzAdHvInbAolSE4mhahPpjXA==} emoji-regex-xs@1.0.0: resolution: {integrity: sha512-LRlerrMYoIDrT6jgpeZ2YYl/L8EulRTt5hQcYjy5AInh7HWXKimpqx68aknBFpGL2+/IcogTcaydJEgaTmOpDg==} @@ -1124,8 +1137,8 @@ packages: resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==} engines: {node: '>=0.10.0'} - langium@4.2.2: - resolution: {integrity: sha512-JUshTRAfHI4/MF9dH2WupvjSXyn8JBuUEWazB8ZVJUtXutT0doDlAv1XKbZ1Pb5sMexa8FF4CFBc0iiul7gbUQ==} + langium@4.2.3: + resolution: {integrity: sha512-sOPIi4hISFnY7twwV97ca1TsxpBtXq0URu/LL1AvxwccPG/RIBBlKS7a/f/EL6w8lTNaS0EFs/F+IdSOaqYpng==} engines: {node: '>=20.10.0', npm: '>=10.2.3'} layout-base@1.0.2: @@ -1275,8 +1288,8 @@ packages: ms@2.1.3: resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} - nanoid@3.3.11: - resolution: {integrity: sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==} + nanoid@3.3.12: + resolution: {integrity: sha512-ZB9RH/39qpq5Vu6Y+NmUaFhQR6pp+M2Xt76XBnEwDaGcVAqhlvxrl3B2bKS5D3NH3QR76v3aSrKaF/Kiy7lEtQ==} engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} hasBin: true @@ -1313,12 +1326,12 @@ packages: points-on-path@0.2.1: resolution: {integrity: sha512-25ClnWWuw7JbWZcgqY/gJ4FQWadKxGWk+3kR/7kD0tCaDtPPMj7oHu2ToLaVhfpnHrZzYby2w6tUA0eOIuUg8g==} - postcss@8.5.6: - resolution: {integrity: sha512-3Ybi1tAuwAP9s0r1UQ2J4n5Y0G05bJkpUIO0/bI9MhwmD70S5aTWbXGBwxHrelT+XM1k6dM0pk+SwNkpTRN7Pg==} + postcss@8.5.13: + resolution: {integrity: sha512-qif0+jGGZoLWdHey3UFHHWP0H7Gbmsk8T5VEqyYFbWqPr1XqvLGBbk/sl8V5exGmcYJklJOhOQq1pV9IcsiFag==} engines: {node: ^10 || ^12 || >=14} - preact@10.28.3: - resolution: {integrity: sha512-tCmoRkPQLpBeWzpmbhryairGnhW9tKV6c6gr/w+RhoRoKEJwsjzipwp//1oCpGPOchvSLaAPlpcJi9MwMmoPyA==} + preact@10.29.1: + resolution: {integrity: sha512-gQCLc/vWroE8lIpleXtdJhTFDogTdZG9AjMUpVkDf2iTCNwYNWA+u16dL41TqUDJO4gm2IgrcMv3uTpjd4Pwmg==} pretty-bytes@7.1.0: resolution: {integrity: sha512-nODzvTiYVRGRqAOvE84Vk5JDPyyxsVk0/fbA/bq7RqlnhksGpset09XTxbpvLTIjoaF7K8Z8DG8yHtKGTPSYRw==} @@ -1415,8 +1428,8 @@ packages: resolution: {integrity: sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==} engines: {node: '>=0.10.0'} - stylis@4.3.6: - resolution: {integrity: sha512-yQ3rwFWRfwNUY7H5vpU0wfdkNSnvnJinhF9830Swlaxl03zsOjCfmX0ugac+3LtK0lYSgwL/KXc8oYL3mG4YFQ==} + stylis@4.4.0: + resolution: {integrity: sha512-5Z9ZpRzfuH6l/UAvCPAPUo3665Nk2wLaZU3x+TLHKVzIz33+sbJqbtrYoC3KD4/uVOr2Zp+L0LySezP9OHV9yA==} superjson@2.2.6: resolution: {integrity: sha512-H+ue8Zo4vJmV2nRjpx86P35lzwDT3nItnIsocgumgr0hHMQ+ZGq5vrERg9kJBo5AWGmxZDhzDo+WVIJqkB0cGA==} @@ -1425,8 +1438,8 @@ packages: tabbable@6.4.0: resolution: {integrity: sha512-05PUHKSNE8ou2dwIxTngl4EzcnsCDZGJ/iCLtDflR/SHB/ny14rXc+qU5P4mG9JkusiV7EivzY9Mhm55AzAvCg==} - tinyexec@1.1.1: - resolution: {integrity: sha512-VKS/ZaQhhkKFMANmAOhhXVoIfBXblQxGX1myCQ2faQrfmobMftXeJPcZGp0gS07ocvGJWDLZGyOZDadDBqYIJg==} + tinyexec@1.1.2: + resolution: {integrity: sha512-dAqSqE/RabpBKI8+h26GfLq6Vb3JVXs30XYQjdMjaj/c2tS8IYYMbIzP599KtRj7c57/wYApb3QjgRgXmrCukA==} engines: {node: '>=18'} tokenx@1.3.0: @@ -1445,8 +1458,8 @@ packages: uc.micro@2.1.0: resolution: {integrity: sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==} - ufo@1.6.3: - resolution: {integrity: sha512-yDJTmhydvl5lJzBmy/hyOAA0d+aqCBuwl818haVdYCRrWV84o7YyeVm4QlVHStqNrrJSTb6jKuFAVqAFsr+K3Q==} + ufo@1.6.4: + resolution: {integrity: sha512-JFNbkD1Svwe0KvGi8GOeLcP4kAWQ609twvCdcHxq1oSL8svv39ZuSvajcD8B+5D0eL4+s1Is2D/O6KN3qcTeRA==} unified@11.0.5: resolution: {integrity: sha512-xKvGhPWw3k84Qjh8bI3ZeJjqnyadK+GEFtazSfZv/rKeTkTjOJho6mFqh2SM96iIcZokxiOpg78GazTSg8+KHA==} @@ -1469,8 +1482,8 @@ packages: unist-util-visit@5.1.0: resolution: {integrity: sha512-m+vIdyeCOpdr/QeQCu2EzxX/ohgS8KbnPDgFni4dQsfSCtpz8UqDyY5GjRru8PDKuYn7Fq19j1CQ+nJSsGKOzg==} - uuid@11.1.0: - resolution: {integrity: sha512-0/A9rDy9P7cJ+8w1c9WD9V//9Wj15Ce2MPz8Ri6032usz+NfePxx5AcN3bN+r6ZL6jEo066/yNYB3tn4pQEx+A==} + uuid@11.1.1: + resolution: {integrity: sha512-vIYxrBCC/N/K+Js3qSN88go7kIfNPssr/hHCesKCQNAjmgvYS2oqr69kIufEG+O4+PfezOH4EbIeHCfFov8ZgQ==} hasBin: true vfile-message@4.0.3: @@ -1510,8 +1523,8 @@ packages: terser: optional: true - vitepress-plugin-llms@1.12.1: - resolution: {integrity: sha512-mUbjxXbNCWIxTZPuxh1smbjRpU1j5Bw5sXKoWeU/kfWCyALE92HyiAXhOgNVAB8QOLCuXticf3Qwsj/YlWROlw==} + vitepress-plugin-llms@1.12.2: + resolution: {integrity: sha512-hdklo7di6E2/MwlYstH7R5QgdPHX+f5G/fp8QBq6MCiw4DWi3IOKMaous0S839FIGsPjK3QHwK6KcFwCf/XzjA==} engines: {node: '>=18.0.0'} vitepress-plugin-mermaid@2.0.17: @@ -1552,8 +1565,8 @@ packages: vscode-uri@3.1.0: resolution: {integrity: sha512-/BpdSx+yCQGnCvecbyXdxHDkuk55/G3xwnC0GqY4gmQ3j+A+g8kzzgB4Nk/SINjqn6+waqw3EgbVF2QKExkRxQ==} - vue@3.5.28: - resolution: {integrity: sha512-BRdrNfeoccSoIZeIhyPBfvWSLFP4q8J3u8Ju8Ug5vu3LdD+yTM13Sg4sKtljxozbnuMu1NB1X5HBHRYUzFocKg==} + vue@3.5.33: + resolution: {integrity: sha512-1AgChhx5w3ALgT4oK3acm2Es/7jyZhWSVUfs3rOBlGQC0rjEDkS7G4lWlJJGGNQD+BV3reCwbQrOe1mPNwKHBQ==} peerDependencies: typescript: '*' peerDependenciesMeta: @@ -1581,128 +1594,128 @@ packages: snapshots: - '@algolia/abtesting@1.14.0': + '@algolia/abtesting@1.18.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/autocomplete-core@1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0)(search-insights@2.17.3)': + '@algolia/autocomplete-core@1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0)(search-insights@2.17.3)': dependencies: - '@algolia/autocomplete-plugin-algolia-insights': 1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0)(search-insights@2.17.3) - '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0) + '@algolia/autocomplete-plugin-algolia-insights': 1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0)(search-insights@2.17.3) + '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0) transitivePeerDependencies: - '@algolia/client-search' - algoliasearch - search-insights - '@algolia/autocomplete-plugin-algolia-insights@1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0)(search-insights@2.17.3)': + '@algolia/autocomplete-plugin-algolia-insights@1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0)(search-insights@2.17.3)': dependencies: - '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0) + '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0) search-insights: 2.17.3 transitivePeerDependencies: - '@algolia/client-search' - algoliasearch - '@algolia/autocomplete-preset-algolia@1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0)': + '@algolia/autocomplete-preset-algolia@1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0)': dependencies: - '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0) - '@algolia/client-search': 5.48.0 - algoliasearch: 5.48.0 + '@algolia/autocomplete-shared': 1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0) + '@algolia/client-search': 5.52.0 + algoliasearch: 5.52.0 - '@algolia/autocomplete-shared@1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0)': + '@algolia/autocomplete-shared@1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0)': dependencies: - '@algolia/client-search': 5.48.0 - algoliasearch: 5.48.0 + '@algolia/client-search': 5.52.0 + algoliasearch: 5.52.0 - '@algolia/client-abtesting@5.48.0': + '@algolia/client-abtesting@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/client-analytics@5.48.0': + '@algolia/client-analytics@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/client-common@5.48.0': {} + '@algolia/client-common@5.52.0': {} - '@algolia/client-insights@5.48.0': + '@algolia/client-insights@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/client-personalization@5.48.0': + '@algolia/client-personalization@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/client-query-suggestions@5.48.0': + '@algolia/client-query-suggestions@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/client-search@5.48.0': + '@algolia/client-search@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/ingestion@1.48.0': + '@algolia/ingestion@1.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/monitoring@1.48.0': + '@algolia/monitoring@1.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/recommend@5.48.0': + '@algolia/recommend@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + '@algolia/client-common': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 - '@algolia/requester-browser-xhr@5.48.0': + '@algolia/requester-browser-xhr@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 + '@algolia/client-common': 5.52.0 - '@algolia/requester-fetch@5.48.0': + '@algolia/requester-fetch@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 + '@algolia/client-common': 5.52.0 - '@algolia/requester-node-http@5.48.0': + '@algolia/requester-node-http@5.52.0': dependencies: - '@algolia/client-common': 5.48.0 + '@algolia/client-common': 5.52.0 '@antfu/install-pkg@1.1.0': dependencies: package-manager-detector: 1.6.0 - tinyexec: 1.1.1 + tinyexec: 1.1.2 '@babel/helper-string-parser@7.27.1': {} '@babel/helper-validator-identifier@7.28.5': {} - '@babel/parser@7.29.0': + '@babel/parser@7.29.3': dependencies: '@babel/types': 7.29.0 @@ -1733,10 +1746,10 @@ snapshots: '@docsearch/css@3.8.2': {} - '@docsearch/js@3.8.2(@algolia/client-search@5.48.0)(search-insights@2.17.3)': + '@docsearch/js@3.8.2(@algolia/client-search@5.52.0)(search-insights@2.17.3)': dependencies: - '@docsearch/react': 3.8.2(@algolia/client-search@5.48.0)(search-insights@2.17.3) - preact: 10.28.3 + '@docsearch/react': 3.8.2(@algolia/client-search@5.52.0)(search-insights@2.17.3) + preact: 10.29.1 transitivePeerDependencies: - '@algolia/client-search' - '@types/react' @@ -1744,12 +1757,12 @@ snapshots: - react-dom - search-insights - '@docsearch/react@3.8.2(@algolia/client-search@5.48.0)(search-insights@2.17.3)': + '@docsearch/react@3.8.2(@algolia/client-search@5.52.0)(search-insights@2.17.3)': dependencies: - '@algolia/autocomplete-core': 1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0)(search-insights@2.17.3) - '@algolia/autocomplete-preset-algolia': 1.17.7(@algolia/client-search@5.48.0)(algoliasearch@5.48.0) + '@algolia/autocomplete-core': 1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0)(search-insights@2.17.3) + '@algolia/autocomplete-preset-algolia': 1.17.7(@algolia/client-search@5.52.0)(algoliasearch@5.52.0) '@docsearch/css': 3.8.2 - algoliasearch: 5.48.0 + algoliasearch: 5.52.0 optionalDependencies: search-insights: 2.17.3 transitivePeerDependencies: @@ -1824,13 +1837,13 @@ snapshots: '@esbuild/win32-x64@0.21.5': optional: true - '@iconify-json/simple-icons@1.2.70': + '@iconify-json/simple-icons@1.2.80': dependencies: '@iconify/types': 2.0.0 '@iconify/types@2.0.0': {} - '@iconify/utils@3.1.0': + '@iconify/utils@3.1.1': dependencies: '@antfu/install-pkg': 1.1.0 '@iconify/types': 2.0.0 @@ -1841,9 +1854,9 @@ snapshots: '@mermaid-js/mermaid-mindmap@9.3.0': dependencies: '@braintree/sanitize-url': 6.0.4 - cytoscape: 3.33.2 - cytoscape-cose-bilkent: 4.1.0(cytoscape@3.33.2) - cytoscape-fcose: 2.2.0(cytoscape@3.33.2) + cytoscape: 3.33.3 + cytoscape-cose-bilkent: 4.1.0(cytoscape@3.33.3) + cytoscape-fcose: 2.2.0(cytoscape@3.33.3) d3: 7.9.0 khroma: 2.1.0 non-layered-tidy-tree-layout: 2.0.2 @@ -1851,7 +1864,7 @@ snapshots: '@mermaid-js/parser@1.1.0': dependencies: - langium: 4.2.2 + langium: 4.2.3 '@rollup/rollup-android-arm-eabi@4.59.0': optional: true @@ -2126,40 +2139,40 @@ snapshots: d3-selection: 3.0.0 d3-transition: 3.0.1(d3-selection@3.0.0) - '@vitejs/plugin-vue@5.2.4(vite@5.4.21)(vue@3.5.28)': + '@vitejs/plugin-vue@5.2.4(vite@5.4.21)(vue@3.5.33)': dependencies: vite: 5.4.21 - vue: 3.5.28 + vue: 3.5.33 - '@vue/compiler-core@3.5.28': + '@vue/compiler-core@3.5.33': dependencies: - '@babel/parser': 7.29.0 - '@vue/shared': 3.5.28 + '@babel/parser': 7.29.3 + '@vue/shared': 3.5.33 entities: 7.0.1 estree-walker: 2.0.2 source-map-js: 1.2.1 - '@vue/compiler-dom@3.5.28': + '@vue/compiler-dom@3.5.33': dependencies: - '@vue/compiler-core': 3.5.28 - '@vue/shared': 3.5.28 + '@vue/compiler-core': 3.5.33 + '@vue/shared': 3.5.33 - '@vue/compiler-sfc@3.5.28': + '@vue/compiler-sfc@3.5.33': dependencies: - '@babel/parser': 7.29.0 - '@vue/compiler-core': 3.5.28 - '@vue/compiler-dom': 3.5.28 - '@vue/compiler-ssr': 3.5.28 - '@vue/shared': 3.5.28 + '@babel/parser': 7.29.3 + '@vue/compiler-core': 3.5.33 + '@vue/compiler-dom': 3.5.33 + '@vue/compiler-ssr': 3.5.33 + '@vue/shared': 3.5.33 estree-walker: 2.0.2 magic-string: 0.30.21 - postcss: 8.5.6 + postcss: 8.5.13 source-map-js: 1.2.1 - '@vue/compiler-ssr@3.5.28': + '@vue/compiler-ssr@3.5.33': dependencies: - '@vue/compiler-dom': 3.5.28 - '@vue/shared': 3.5.28 + '@vue/compiler-dom': 3.5.33 + '@vue/shared': 3.5.33 '@vue/devtools-api@7.7.9': dependencies: @@ -2179,36 +2192,36 @@ snapshots: dependencies: rfdc: 1.4.1 - '@vue/reactivity@3.5.28': + '@vue/reactivity@3.5.33': dependencies: - '@vue/shared': 3.5.28 + '@vue/shared': 3.5.33 - '@vue/runtime-core@3.5.28': + '@vue/runtime-core@3.5.33': dependencies: - '@vue/reactivity': 3.5.28 - '@vue/shared': 3.5.28 + '@vue/reactivity': 3.5.33 + '@vue/shared': 3.5.33 - '@vue/runtime-dom@3.5.28': + '@vue/runtime-dom@3.5.33': dependencies: - '@vue/reactivity': 3.5.28 - '@vue/runtime-core': 3.5.28 - '@vue/shared': 3.5.28 + '@vue/reactivity': 3.5.33 + '@vue/runtime-core': 3.5.33 + '@vue/shared': 3.5.33 csstype: 3.2.3 - '@vue/server-renderer@3.5.28(vue@3.5.28)': + '@vue/server-renderer@3.5.33(vue@3.5.33)': dependencies: - '@vue/compiler-ssr': 3.5.28 - '@vue/shared': 3.5.28 - vue: 3.5.28 + '@vue/compiler-ssr': 3.5.33 + '@vue/shared': 3.5.33 + vue: 3.5.33 - '@vue/shared@3.5.28': {} + '@vue/shared@3.5.33': {} '@vueuse/core@12.8.2': dependencies: '@types/web-bluetooth': 0.0.21 '@vueuse/metadata': 12.8.2 '@vueuse/shared': 12.8.2 - vue: 3.5.28 + vue: 3.5.33 transitivePeerDependencies: - typescript @@ -2216,7 +2229,7 @@ snapshots: dependencies: '@vueuse/core': 12.8.2 '@vueuse/shared': 12.8.2 - vue: 3.5.28 + vue: 3.5.33 optionalDependencies: focus-trap: 7.8.0 transitivePeerDependencies: @@ -2226,28 +2239,28 @@ snapshots: '@vueuse/shared@12.8.2': dependencies: - vue: 3.5.28 + vue: 3.5.33 transitivePeerDependencies: - typescript acorn@8.16.0: {} - algoliasearch@5.48.0: - dependencies: - '@algolia/abtesting': 1.14.0 - '@algolia/client-abtesting': 5.48.0 - '@algolia/client-analytics': 5.48.0 - '@algolia/client-common': 5.48.0 - '@algolia/client-insights': 5.48.0 - '@algolia/client-personalization': 5.48.0 - '@algolia/client-query-suggestions': 5.48.0 - '@algolia/client-search': 5.48.0 - '@algolia/ingestion': 1.48.0 - '@algolia/monitoring': 1.48.0 - '@algolia/recommend': 5.48.0 - '@algolia/requester-browser-xhr': 5.48.0 - '@algolia/requester-fetch': 5.48.0 - '@algolia/requester-node-http': 5.48.0 + algoliasearch@5.52.0: + dependencies: + '@algolia/abtesting': 1.18.0 + '@algolia/client-abtesting': 5.52.0 + '@algolia/client-analytics': 5.52.0 + '@algolia/client-common': 5.52.0 + '@algolia/client-insights': 5.52.0 + '@algolia/client-personalization': 5.52.0 + '@algolia/client-query-suggestions': 5.52.0 + '@algolia/client-search': 5.52.0 + '@algolia/ingestion': 1.52.0 + '@algolia/monitoring': 1.52.0 + '@algolia/recommend': 5.52.0 + '@algolia/requester-browser-xhr': 5.52.0 + '@algolia/requester-fetch': 5.52.0 + '@algolia/requester-node-http': 5.52.0 ansi-regex@5.0.1: {} @@ -2279,7 +2292,7 @@ snapshots: character-entities@2.0.2: {} - chevrotain-allstar@0.4.1(chevrotain@12.0.0): + chevrotain-allstar@0.4.3(chevrotain@12.0.0): dependencies: chevrotain: 12.0.0 lodash-es: 4.18.1 @@ -2326,17 +2339,17 @@ snapshots: csstype@3.2.3: {} - cytoscape-cose-bilkent@4.1.0(cytoscape@3.33.2): + cytoscape-cose-bilkent@4.1.0(cytoscape@3.33.3): dependencies: cose-base: 1.0.3 - cytoscape: 3.33.2 + cytoscape: 3.33.3 - cytoscape-fcose@2.2.0(cytoscape@3.33.2): + cytoscape-fcose@2.2.0(cytoscape@3.33.3): dependencies: cose-base: 2.2.0 - cytoscape: 3.33.2 + cytoscape: 3.33.3 - cytoscape@3.33.2: {} + cytoscape@3.33.3: {} d3-array@2.12.1: dependencies: @@ -2530,7 +2543,7 @@ snapshots: dependencies: dequal: 2.0.3 - dompurify@3.4.0: + dompurify@3.4.2: optionalDependencies: '@types/trusted-types': 2.0.7 @@ -2657,11 +2670,11 @@ snapshots: kind-of@6.0.3: {} - langium@4.2.2: + langium@4.2.3: dependencies: '@chevrotain/regexp-to-ast': 12.0.0 chevrotain: 12.0.0 - chevrotain-allstar: 0.4.1(chevrotain@12.0.0) + chevrotain-allstar: 0.4.3(chevrotain@12.0.0) vscode-languageserver: 9.0.1 vscode-languageserver-textdocument: 1.0.12 vscode-uri: 3.1.0 @@ -2765,26 +2778,26 @@ snapshots: mermaid@11.14.0: dependencies: '@braintree/sanitize-url': 7.1.2 - '@iconify/utils': 3.1.0 + '@iconify/utils': 3.1.1 '@mermaid-js/parser': 1.1.0 '@types/d3': 7.4.3 '@upsetjs/venn.js': 2.0.0 - cytoscape: 3.33.2 - cytoscape-cose-bilkent: 4.1.0(cytoscape@3.33.2) - cytoscape-fcose: 2.2.0(cytoscape@3.33.2) + cytoscape: 3.33.3 + cytoscape-cose-bilkent: 4.1.0(cytoscape@3.33.3) + cytoscape-fcose: 2.2.0(cytoscape@3.33.3) d3: 7.9.0 d3-sankey: 0.12.3 dagre-d3-es: 7.0.14 dayjs: 1.11.20 - dompurify: 3.4.0 + dompurify: 3.4.2 katex: 0.16.45 khroma: 2.1.0 lodash-es: 4.18.1 marked: 16.4.2 roughjs: 4.6.6 - stylis: 4.3.6 + stylis: 4.4.0 ts-dedent: 2.2.0 - uuid: 11.1.0 + uuid: 11.1.1 micromark-core-commonmark@2.0.3: dependencies: @@ -2943,11 +2956,11 @@ snapshots: acorn: 8.16.0 pathe: 2.0.3 pkg-types: 1.3.1 - ufo: 1.6.3 + ufo: 1.6.4 ms@2.1.3: {} - nanoid@3.3.11: {} + nanoid@3.3.12: {} non-layered-tidy-tree-layout@2.0.2: optional: true @@ -2983,13 +2996,13 @@ snapshots: path-data-parser: 0.1.0 points-on-curve: 0.2.0 - postcss@8.5.6: + postcss@8.5.13: dependencies: - nanoid: 3.3.11 + nanoid: 3.3.12 picocolors: 1.1.1 source-map-js: 1.2.1 - preact@10.28.3: {} + preact@10.29.1: {} pretty-bytes@7.1.0: {} @@ -3131,7 +3144,7 @@ snapshots: strip-bom-string@1.0.0: {} - stylis@4.3.6: {} + stylis@4.4.0: {} superjson@2.2.6: dependencies: @@ -3139,7 +3152,7 @@ snapshots: tabbable@6.4.0: {} - tinyexec@1.1.1: {} + tinyexec@1.1.2: {} tokenx@1.3.0: {} @@ -3151,7 +3164,7 @@ snapshots: uc.micro@2.1.0: {} - ufo@1.6.3: {} + ufo@1.6.4: {} unified@11.0.5: dependencies: @@ -3192,7 +3205,7 @@ snapshots: unist-util-is: 6.0.1 unist-util-visit-parents: 6.0.2 - uuid@11.1.0: {} + uuid@11.1.1: {} vfile-message@4.0.3: dependencies: @@ -3207,12 +3220,12 @@ snapshots: vite@5.4.21: dependencies: esbuild: 0.21.5 - postcss: 8.5.6 + postcss: 8.5.13 rollup: 4.59.0 optionalDependencies: fsevents: 2.3.3 - vitepress-plugin-llms@1.12.1: + vitepress-plugin-llms@1.12.2: dependencies: gray-matter: 4.0.3 markdown-it: 14.1.1 @@ -3231,25 +3244,25 @@ snapshots: transitivePeerDependencies: - supports-color - vitepress-plugin-mermaid@2.0.17(mermaid@11.14.0)(vitepress@1.6.4(@algolia/client-search@5.48.0)(postcss@8.5.6)(search-insights@2.17.3)): + vitepress-plugin-mermaid@2.0.17(mermaid@11.14.0)(vitepress@1.6.4(@algolia/client-search@5.52.0)(postcss@8.5.13)(search-insights@2.17.3)): dependencies: mermaid: 11.14.0 - vitepress: 1.6.4(@algolia/client-search@5.48.0)(postcss@8.5.6)(search-insights@2.17.3) + vitepress: 1.6.4(@algolia/client-search@5.52.0)(postcss@8.5.13)(search-insights@2.17.3) optionalDependencies: '@mermaid-js/mermaid-mindmap': 9.3.0 - vitepress@1.6.4(@algolia/client-search@5.48.0)(postcss@8.5.6)(search-insights@2.17.3): + vitepress@1.6.4(@algolia/client-search@5.52.0)(postcss@8.5.13)(search-insights@2.17.3): dependencies: '@docsearch/css': 3.8.2 - '@docsearch/js': 3.8.2(@algolia/client-search@5.48.0)(search-insights@2.17.3) - '@iconify-json/simple-icons': 1.2.70 + '@docsearch/js': 3.8.2(@algolia/client-search@5.52.0)(search-insights@2.17.3) + '@iconify-json/simple-icons': 1.2.80 '@shikijs/core': 2.5.0 '@shikijs/transformers': 2.5.0 '@shikijs/types': 2.5.0 '@types/markdown-it': 14.1.2 - '@vitejs/plugin-vue': 5.2.4(vite@5.4.21)(vue@3.5.28) + '@vitejs/plugin-vue': 5.2.4(vite@5.4.21)(vue@3.5.33) '@vue/devtools-api': 7.7.9 - '@vue/shared': 3.5.28 + '@vue/shared': 3.5.33 '@vueuse/core': 12.8.2 '@vueuse/integrations': 12.8.2(focus-trap@7.8.0) focus-trap: 7.8.0 @@ -3257,9 +3270,9 @@ snapshots: minisearch: 7.2.0 shiki: 2.5.0 vite: 5.4.21 - vue: 3.5.28 + vue: 3.5.33 optionalDependencies: - postcss: 8.5.6 + postcss: 8.5.13 transitivePeerDependencies: - '@algolia/client-search' - '@types/node' @@ -3304,13 +3317,13 @@ snapshots: vscode-uri@3.1.0: {} - vue@3.5.28: + vue@3.5.33: dependencies: - '@vue/compiler-dom': 3.5.28 - '@vue/compiler-sfc': 3.5.28 - '@vue/runtime-dom': 3.5.28 - '@vue/server-renderer': 3.5.28(vue@3.5.28) - '@vue/shared': 3.5.28 + '@vue/compiler-dom': 3.5.33 + '@vue/compiler-sfc': 3.5.33 + '@vue/runtime-dom': 3.5.33 + '@vue/server-renderer': 3.5.33(vue@3.5.33) + '@vue/shared': 3.5.33 wrap-ansi@7.0.0: dependencies: diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml new file mode 100644 index 0000000..872d4bd --- /dev/null +++ b/pnpm-workspace.yaml @@ -0,0 +1,7 @@ +overrides: + 'lodash-es@<=4.17.23': '>=4.18.0' + 'rollup@>=4.0.0 <4.59.0': '4.59.0' + 'minimatch@>=10.0.0 <10.2.3': '10.2.3' + +allowBuilds: + esbuild: true From cc85bc6a1466399990370e95fcd9451b9cae8fd5 Mon Sep 17 00:00:00 2001 From: intech Date: Tue, 5 May 2026 00:49:17 +0400 Subject: [PATCH 2/4] docs(api): regenerate TypeDoc reference under pnpm 11 Side-effect of running gen-api-docs.sh during pnpm 11 migration smoke tests. TypeDoc output normalized to current source state across all 13 @connectum/* packages. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../auth/classes/AuthzDeniedError.md | 38 ++++---- 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 +- .../functions/createJwtAuthInterceptor.md | 2 +- .../functions/createProtoAuthzInterceptor.md | 2 +- .../functions/createSessionAuthInterceptor.md | 2 +- .../auth/functions/getAuthContext.md | 2 +- .../auth/functions/getPublicMethods.md | 2 +- .../auth/functions/matchesMethodPattern.md | 2 +- .../auth/functions/parseAuthHeaders.md | 2 +- .../auth/functions/requireAuthContext.md | 2 +- .../auth/functions/resolveMethodAuth.md | 2 +- .../auth/functions/setAuthHeaders.md | 2 +- .../@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 +-- .../interfaces/JwtAuthInterceptorOptions.md | 22 ++--- .../ProtoAuthzInterceptorOptions.md | 8 +- .../auth/interfaces/ResolvedMethodAuth.md | 8 +- .../SessionAuthInterceptorOptions.md | 16 ++-- .../functions/createMockAuthContext.md | 2 +- .../auth/testing/functions/createTestJwt.md | 2 +- .../auth/testing/functions/withAuthContext.md | 2 +- .../auth/testing/variables/TEST_JWT_SECRET.md | 2 +- .../auth/type-aliases/AuthzEffect.md | 2 +- .../auth/type-aliases/InterceptorFactory.md | 2 +- .../@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 +- .../@connectum/core/functions/createServer.md | 2 +- .../@connectum/core/functions/getTLSPath.md | 2 +- .../core/functions/isSanitizableError.md | 2 +- .../core/functions/parseEnvConfig.md | 2 +- .../core/functions/readTLSCertificates.md | 2 +- .../core/functions/safeParseEnvConfig.md | 2 +- .../core/interfaces/SanitizableError.md | 6 +- .../core/type-aliases/ConnectumEnv.md | 2 +- .../types/interfaces/CreateServerOptions.md | 24 ++--- .../core/types/interfaces/EventBusLike.md | 6 +- .../core/types/interfaces/ProtocolContext.md | 4 +- .../types/interfaces/ProtocolRegistration.md | 8 +- .../core/types/interfaces/Server.md | 92 +++++++++---------- .../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/ServiceRoute.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/LogFormatSchema.md | 2 +- .../core/variables/LogLevelSchema.md | 2 +- .../core/variables/LoggerBackendSchema.md | 2 +- .../core/variables/NodeEnvSchema.md | 2 +- en/api/@connectum/core/variables/tlsPath.md | 2 +- .../events-amqp/functions/AmqpAdapter.md | 2 +- .../events-amqp/functions/toAmqpPattern.md | 2 +- .../types/interfaces/AmqpAdapterOptions.md | 18 ++-- .../types/interfaces/AmqpConsumerOptions.md | 6 +- .../types/interfaces/AmqpExchangeOptions.md | 6 +- .../types/interfaces/AmqpPublisherOptions.md | 6 +- .../types/interfaces/AmqpQueueOptions.md | 12 +-- .../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 | 14 +-- .../events/classes/RetryableError.md | 14 +-- .../events/functions/MemoryAdapter.md | 2 +- .../events/functions/composeMiddleware.md | 2 +- .../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 +- .../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 | 16 ++-- .../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 | 12 +-- .../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 | 14 +-- .../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/createDefaultInterceptors.md | 2 +- .../interfaces/DefaultInterceptorOptions.md | 18 ++-- .../createErrorHandlerInterceptor.md | 2 +- .../functions/createFallbackInterceptor.md | 2 +- .../interfaces/BulkheadOptions.md | 8 +- .../interfaces/CircuitBreakerOptions.md | 8 +- .../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 +- .../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 +- .../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 +- en/api/@connectum/otel/interfaces/Meter.md | 24 +++-- .../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 +- en/api/@connectum/otel/interfaces/Tracer.md | 14 ++- .../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 +- .../otel/provider/functions/getProvider.md | 2 +- .../otel/provider/functions/initProvider.md | 2 +- .../provider/functions/shutdownProvider.md | 2 +- .../provider/interfaces/ProviderOptions.md | 8 +- .../shared/functions/applyAttributeFilter.md | 2 +- .../shared/functions/buildBaseAttributes.md | 2 +- .../shared/functions/buildErrorAttributes.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 +- .../testing/index/functions/createMockFn.md | 2 +- .../testing/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/functions/createTestServer.md | 2 +- .../testing/index/functions/withTestServer.md | 2 +- .../testing/index/interfaces/MockCall.md | 4 +- .../testing/index/interfaces/MockFn.md | 6 +- .../interfaces/CreateTestServerOptions.md | 10 +- .../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 +- .../testing/types/interfaces/TestServer.md | 10 +- 248 files changed, 679 insertions(+), 671 deletions(-) diff --git a/en/api/@connectum/auth/classes/AuthzDeniedError.md b/en/api/@connectum/auth/classes/AuthzDeniedError.md index 5e828fc..2708e77 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L26) +Defined in: [packages/auth/src/errors.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L39) +Defined in: [packages/auth/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L29) +Defined in: [packages/auth/src/errors.ts:29](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L29) *** @@ -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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:46 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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 @@ -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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L27) +Defined in: [packages/auth/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L27) #### Implementation of @@ -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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:20 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:32 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:24 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:40 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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.1\_@bufbuild+protobuf@2. > `readonly` **rawMessage**: `string` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:39 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:39 The error message, but without a status code in front. @@ -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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L28) +Defined in: [packages/auth/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L28) *** @@ -188,7 +188,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:67 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:67 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L31) +Defined in: [packages/auth/src/errors.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L31) ##### Returns @@ -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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:77 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:78 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/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.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:68 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:68 #### Parameters @@ -314,7 +314,7 @@ Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:51 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:51 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -384,7 +384,7 @@ a(); > `static` **from**(`reason`, `code?`): `ConnectError` -Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.11.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:67 +Defined in: node\_modules/.pnpm/@connectrpc+connect@2.1.1\_@bufbuild+protobuf@2.12.0/node\_modules/@connectrpc/connect/dist/esm/connect-error.d.ts:67 Convert any value - typically a caught error into a ConnectError, following these rules: @@ -445,7 +445,7 @@ Indicates whether the argument provided is a built-in Error instance or not. > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:55 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:55 #### Parameters diff --git a/en/api/@connectum/auth/classes/LruCache.md b/en/api/@connectum/auth/classes/LruCache.md index 3414eff..3072ddd 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/cache.ts#L13) +Defined in: [packages/auth/src/cache.ts:13](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/cache.ts#L18) +Defined in: [packages/auth/src/cache.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/cache.ts#L63) +Defined in: [packages/auth/src/cache.ts:63](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/cache.ts#L59) +Defined in: [packages/auth/src/cache.ts:59](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/cache.ts#L26) +Defined in: [packages/auth/src/cache.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/cache.ts#L41) +Defined in: [packages/auth/src/cache.ts:41](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 c9265d4..bbab340 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/auth-interceptor.ts#L81) +Defined in: [packages/auth/src/auth-interceptor.ts:81](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 4d31a12..60c59c0 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/authz-interceptor.ts#L85) +Defined in: [packages/auth/src/authz-interceptor.ts:85](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 76b5ccd..948e2cd 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 8fa7513..67a365f 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 1596d97..1980dff 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/gateway-auth-interceptor.ts#L92) Create a gateway authentication interceptor. diff --git a/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md b/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md index 1d9b03c..1f276fc 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 b1157b9..df6a757 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/proto-authz-interceptor.ts#L125) +Defined in: [packages/auth/src/proto/proto-authz-interceptor.ts:125](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/proto-authz-interceptor.ts#L125) Create a proto-based authorization interceptor. diff --git a/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md b/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md index f9e4c2f..89efe8f 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 4998d1b..36d7b3f 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/context.ts#L111) +Defined in: [packages/auth/src/context.ts:111](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/context.ts#L111) Get the current auth context. diff --git a/en/api/@connectum/auth/functions/getPublicMethods.md b/en/api/@connectum/auth/functions/getPublicMethods.md index 19d4af1..0f8b80d 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/reader.ts#L165) +Defined in: [packages/auth/src/proto/reader.ts:165](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L165) 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 1f432aa..ff903b1 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/method-match.ts#L23) +Defined in: [packages/auth/src/method-match.ts:23](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/parseAuthHeaders.md b/en/api/@connectum/auth/functions/parseAuthHeaders.md index b97fa32..3f0608c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/headers.ts#L92) +Defined in: [packages/auth/src/headers.ts:92](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 8bef841..5b235b3 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/context.ts#L124) +Defined in: [packages/auth/src/context.ts:124](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 beb379a..fe32728 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/reader.ts#L65) +Defined in: [packages/auth/src/proto/reader.ts:65](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L65) Resolve the effective authorization configuration for an RPC method. diff --git a/en/api/@connectum/auth/functions/setAuthHeaders.md b/en/api/@connectum/auth/functions/setAuthHeaders.md index 3334985..50066a1 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/headers.ts#L36) +Defined in: [packages/auth/src/headers.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/headers.ts#L36) Serialize AuthContext to request headers. diff --git a/en/api/@connectum/auth/interfaces/AuthContext.md b/en/api/@connectum/auth/interfaces/AuthContext.md index 7116f58..79b0cf3 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L22) +Defined in: [packages/auth/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L32) +Defined in: [packages/auth/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L36) +Defined in: [packages/auth/src/types.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L26) +Defined in: [packages/auth/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L28) +Defined in: [packages/auth/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L30) +Defined in: [packages/auth/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L24) +Defined in: [packages/auth/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L34) +Defined in: [packages/auth/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 2aefa60..a3263bc 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L115) +Defined in: [packages/auth/src/types.ts:115](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L151) +Defined in: [packages/auth/src/types.ts:151](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L123) +Defined in: [packages/auth/src/types.ts:123](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L158) +Defined in: [packages/auth/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L145) +Defined in: [packages/auth/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L139) +Defined in: [packages/auth/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L132) +Defined in: [packages/auth/src/types.ts:132](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 572cdd5..efd5169 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L14) +Defined in: [packages/auth/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L16) +Defined in: [packages/auth/src/errors.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L17) +Defined in: [packages/auth/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/errors.ts#L15) +Defined in: [packages/auth/src/errors.ts:15](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 2bf1e84..5bb643a 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L244) +Defined in: [packages/auth/src/types.ts:244](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L266) +Defined in: [packages/auth/src/types.ts:266](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L249) +Defined in: [packages/auth/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L255) +Defined in: [packages/auth/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L272) +Defined in: [packages/auth/src/types.ts:272](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 989ed18..0772726 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L81) +Defined in: [packages/auth/src/types.ts:81](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L87) +Defined in: [packages/auth/src/types.ts:87](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L85) +Defined in: [packages/auth/src/types.ts:85](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L83) +Defined in: [packages/auth/src/types.ts:83](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L94) +Defined in: [packages/auth/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 adc84c7..599d2f6 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L105) +Defined in: [packages/auth/src/types.ts:105](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L109) +Defined in: [packages/auth/src/types.ts:109](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L107) +Defined in: [packages/auth/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 81a6da8..cc5213d 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L367) +Defined in: [packages/auth/src/types.ts:367](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L367) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L375) +Defined in: [packages/auth/src/types.ts:375](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L375) 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 72b30df..f877388 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L383) +Defined in: [packages/auth/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L383) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L389) +Defined in: [packages/auth/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L389) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L385) +Defined in: [packages/auth/src/types.ts:385](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L385) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L387) +Defined in: [packages/auth/src/types.ts:387](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L387) 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 8ca9649..0315e66 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L301) +Defined in: [packages/auth/src/types.ts:301](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L318) +Defined in: [packages/auth/src/types.ts:318](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L303) +Defined in: [packages/auth/src/types.ts:303](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L316) +Defined in: [packages/auth/src/types.ts:316](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L314) +Defined in: [packages/auth/src/types.ts:314](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L312) +Defined in: [packages/auth/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L305) +Defined in: [packages/auth/src/types.ts:305](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 fdf4195..ab0db0b 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L280) +Defined in: [packages/auth/src/types.ts:280](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L292) +Defined in: [packages/auth/src/types.ts:292](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L284) +Defined in: [packages/auth/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L286) +Defined in: [packages/auth/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L288) +Defined in: [packages/auth/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L282) +Defined in: [packages/auth/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L290) +Defined in: [packages/auth/src/types.ts:290](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L290) Header containing credential type diff --git a/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md index f6948e5..e10c194 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L164) +Defined in: [packages/auth/src/types.ts:164](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L210) +Defined in: [packages/auth/src/types.ts:210](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L208) +Defined in: [packages/auth/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L215) +Defined in: [packages/auth/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L206) +Defined in: [packages/auth/src/types.ts:206](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L166) +Defined in: [packages/auth/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L228) +Defined in: [packages/auth/src/types.ts:228](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L238) +Defined in: [packages/auth/src/types.ts:238](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L204) +Defined in: [packages/auth/src/types.ts:204](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L204) Asymmetric public key for JWT signature verification. @@ -151,7 +151,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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L168) +Defined in: [packages/auth/src/types.ts:168](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L168) HMAC symmetric secret (for HS256/HS384/HS512) @@ -161,7 +161,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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L233) +Defined in: [packages/auth/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L233) Methods to skip authentication for. diff --git a/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md b/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md index 4e76f91..a0a05b5 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L398) +Defined in: [packages/auth/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L398) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L417) +Defined in: [packages/auth/src/types.ts:417](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L417) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L403) +Defined in: [packages/auth/src/types.ts:403](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L403) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L408) +Defined in: [packages/auth/src/types.ts:408](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L408) 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 4900925..d8bf9bf 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/reader.ts#L20) +Defined in: [packages/auth/src/proto/reader.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L20) Resolved authorization configuration for a single RPC method. @@ -14,7 +14,7 @@ Result of merging service-level defaults with method-level overrides. > `readonly` **policy**: `"allow"` \| `"deny"` \| `undefined` -Defined in: [packages/auth/src/proto/reader.ts:24](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/reader.ts#L24) +Defined in: [packages/auth/src/proto/reader.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L24) Authorization policy: "allow", "deny", or undefined (use interceptor default). @@ -24,7 +24,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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/reader.ts#L22) +Defined in: [packages/auth/src/proto/reader.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L22) Whether the method is public (skip authn + authz). @@ -34,6 +34,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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/proto/reader.ts#L26) +Defined in: [packages/auth/src/proto/reader.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L26) 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 745cf2f..02e142d 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L326) +Defined in: [packages/auth/src/types.ts:326](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L326) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L349) +Defined in: [packages/auth/src/types.ts:349](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L349) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L347) +Defined in: [packages/auth/src/types.ts:347](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L347) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L342) +Defined in: [packages/auth/src/types.ts:342](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L342) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L359) +Defined in: [packages/auth/src/types.ts:359](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L359) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L353) +Defined in: [packages/auth/src/types.ts:353](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L353) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L351) +Defined in: [packages/auth/src/types.ts:351](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L351) 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L335) +Defined in: [packages/auth/src/types.ts:335](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L335) Verify session token and return raw session data. Must throw on invalid/expired sessions. diff --git a/en/api/@connectum/auth/testing/functions/createMockAuthContext.md b/en/api/@connectum/auth/testing/functions/createMockAuthContext.md index f1a94f7..52947fe 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 d3ad5cb..d572f20 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/withAuthContext.md b/en/api/@connectum/auth/testing/functions/withAuthContext.md index e8704c2..f1469ed 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/testing/with-context.ts#L31) Run a function with a pre-set AuthContext. 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 1b52c2b..ff325fa 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/638fd0bfcd1daf229a925892579ece032b17742c/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 b2f40a1..9cbfdf0 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L67) +Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 5b59602..da29647 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L14) +Defined in: [packages/auth/src/types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L14) Interceptor factory function type diff --git a/en/api/@connectum/auth/variables/AUTH_HEADERS.md b/en/api/@connectum/auth/variables/AUTH_HEADERS.md index b0ed2b5..4494a1a 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L49) +Defined in: [packages/auth/src/types.ts:49](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 38b9da0..6106efc 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/types.ts#L67) +Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 7208173..a51fa07 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/auth/src/context.ts#L87) +Defined in: [packages/auth/src/context.ts:87](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 9bef417..9539fc1 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L41) +Defined in: [commands/proto-sync.ts:41](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 df282e3..9072c2e 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L25) +Defined in: [commands/proto-sync.ts:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L33) +Defined in: [commands/proto-sync.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L27) +Defined in: [commands/proto-sync.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L29) +Defined in: [commands/proto-sync.ts:29](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L31) +Defined in: [commands/proto-sync.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 84cea84..3f42577 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/commands/proto-sync.ts#L113) +Defined in: [commands/proto-sync.ts:113](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 efde578..597a321 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/utils/reflection.ts#L72) +Defined in: [utils/reflection.ts:72](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 4c181f3..193acdb 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/utils/reflection.ts#L42) +Defined in: [utils/reflection.ts:42](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 7705d53..92f3f68 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/utils/reflection.ts#L19) +Defined in: [utils/reflection.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/utils/reflection.ts#L25) +Defined in: [utils/reflection.ts:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/utils/reflection.ts#L23) +Defined in: [utils/reflection.ts:23](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/cli/src/utils/reflection.ts#L21) +Defined in: [utils/reflection.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L21) List of fully-qualified service names diff --git a/en/api/@connectum/core/functions/createServer.md b/en/api/@connectum/core/functions/createServer.md index 1e8d2ea..9016181 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:297](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/Server.ts#L297) +Defined in: [packages/core/src/Server.ts:297](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/Server.ts#L297) Create a new server instance diff --git a/en/api/@connectum/core/functions/getTLSPath.md b/en/api/@connectum/core/functions/getTLSPath.md index 4a4268a..40b6b4b 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/TLSConfig.ts#L20) +Defined in: [packages/core/src/TLSConfig.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 659e3d6..d9b1481 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/errors.ts#L28) +Defined in: [packages/core/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/errors.ts#L28) Type guard for SanitizableError. diff --git a/en/api/@connectum/core/functions/parseEnvConfig.md b/en/api/@connectum/core/functions/parseEnvConfig.md index 693872b..8d7db5c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L145) +Defined in: [packages/core/src/config/envSchema.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L145) Parse and validate environment configuration diff --git a/en/api/@connectum/core/functions/readTLSCertificates.md b/en/api/@connectum/core/functions/readTLSCertificates.md index bcd995a..0aa994a 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/TLSConfig.ts#L36) +Defined in: [packages/core/src/TLSConfig.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/TLSConfig.ts#L36) Read TLS certificates from configuration diff --git a/en/api/@connectum/core/functions/safeParseEnvConfig.md b/en/api/@connectum/core/functions/safeParseEnvConfig.md index 9d43d0a..aa57f09 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"` \| `"debug"` \| `"info"` \| `"warn"`; `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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L162) +Defined in: [packages/core/src/config/envSchema.ts:162](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L162) Safely parse environment configuration (returns result object) diff --git a/en/api/@connectum/core/interfaces/SanitizableError.md b/en/api/@connectum/core/interfaces/SanitizableError.md index 2990b36..cb56151 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/errors.ts#L17) +Defined in: [packages/core/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/errors.ts#L18) +Defined in: [packages/core/src/errors.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/errors.ts#L19) +Defined in: [packages/core/src/errors.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/errors.ts#L19) diff --git a/en/api/@connectum/core/type-aliases/ConnectumEnv.md b/en/api/@connectum/core/type-aliases/ConnectumEnv.md index 2da8b2e..7617687 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L133) +Defined in: [packages/core/src/config/envSchema.ts:133](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L133) Connectum environment configuration type diff --git a/en/api/@connectum/core/types/interfaces/CreateServerOptions.md b/en/api/@connectum/core/types/interfaces/CreateServerOptions.md index f6a3641..4b1e3ba 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:214](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L214) +Defined in: [packages/core/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L214) Server configuration options for createServer() @@ -12,7 +12,7 @@ Server configuration options for createServer() > `optional` **allowHTTP1?**: `boolean` -Defined in: [packages/core/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L298) +Defined in: [packages/core/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L298) Allow HTTP/1.1 connections. @@ -32,7 +32,7 @@ true > `optional` **eventBus?**: [`EventBusLike`](EventBusLike.md) -Defined in: [packages/core/src/types.ts:287](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L287) +Defined in: [packages/core/src/types.ts:287](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L287) Event bus instance for pub/sub messaging. @@ -62,7 +62,7 @@ const server = createServer({ > `optional` **handshakeTimeout?**: `number` -Defined in: [packages/core/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L304) +Defined in: [packages/core/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L304) Handshake timeout in milliseconds @@ -78,7 +78,7 @@ Handshake timeout in milliseconds > `optional` **host?**: `string` -Defined in: [packages/core/src/types.ts:230](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L230) +Defined in: [packages/core/src/types.ts:230](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L230) Server host to bind @@ -94,7 +94,7 @@ Server host to bind > `optional` **http2Options?**: `SecureServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`, *typeof* `Http2ServerRequest`, *typeof* `Http2ServerResponse`\> -Defined in: [packages/core/src/types.ts:309](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L309) +Defined in: [packages/core/src/types.ts:309](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L309) Additional HTTP/2 server options @@ -104,7 +104,7 @@ Additional HTTP/2 server options > `optional` **interceptors?**: `Interceptor`[] -Defined in: [packages/core/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L263) +Defined in: [packages/core/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L263) ConnectRPC interceptors. When omitted or `[]`, no interceptors are applied. @@ -116,7 +116,7 @@ Use `createDefaultInterceptors()` from `@connectum/interceptors` to get the defa > `optional` **port?**: `number` -Defined in: [packages/core/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L224) +Defined in: [packages/core/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L224) Server port @@ -132,7 +132,7 @@ Server port > `optional` **protocols?**: [`ProtocolRegistration`](ProtocolRegistration.md)[] -Defined in: [packages/core/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L251) +Defined in: [packages/core/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L251) Protocol registrations (healthcheck, reflection, custom) @@ -154,7 +154,7 @@ const server = createServer({ > **services**: [`ServiceRoute`](../type-aliases/ServiceRoute.md)[] -Defined in: [packages/core/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L218) +Defined in: [packages/core/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L218) Service routes to register @@ -164,7 +164,7 @@ Service routes to register > `optional` **shutdown?**: [`ShutdownOptions`](ShutdownOptions.md) -Defined in: [packages/core/src/types.ts:256](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L256) +Defined in: [packages/core/src/types.ts:256](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L256) Graceful shutdown configuration @@ -174,6 +174,6 @@ Graceful shutdown configuration > `optional` **tls?**: [`TLSOptions`](TLSOptions.md) -Defined in: [packages/core/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L235) +Defined in: [packages/core/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L235) TLS configuration diff --git a/en/api/@connectum/core/types/interfaces/EventBusLike.md b/en/api/@connectum/core/types/interfaces/EventBusLike.md index fa79619..0b34c04 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:126](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L126) +Defined in: [packages/core/src/types.ts:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L126) 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:133](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L133) +Defined in: [packages/core/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L133) 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:135](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L135) +Defined in: [packages/core/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L135) 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 21349af..3576aad 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:51](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L51) +Defined in: [packages/core/src/types.ts:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L51) 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:53](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L53) +Defined in: [packages/core/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L53) 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 d375050..83efb44 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:84](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L84) +Defined in: [packages/core/src/types.ts:84](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L84) Protocol registration interface @@ -31,7 +31,7 @@ const server = createServer({ > `optional` **httpHandler?**: [`HttpHandler`](../type-aliases/HttpHandler.md) -Defined in: [packages/core/src/types.ts:92](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L92) +Defined in: [packages/core/src/types.ts:92](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L92) 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:86](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L86) +Defined in: [packages/core/src/types.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L86) 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:89](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L89) +Defined in: [packages/core/src/types.ts:89](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L89) 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 0ec512f..5dad68d 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:333](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L333) +Defined in: [packages/core/src/types.ts:333](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L333) Server interface with explicit lifecycle control @@ -35,7 +35,7 @@ await server.stop(); > `readonly` **address**: `AddressInfo` \| `null` -Defined in: [packages/core/src/types.ts:361](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L361) +Defined in: [packages/core/src/types.ts:361](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L361) 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:501](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L501) +Defined in: [packages/core/src/types.ts:501](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L501) 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:489](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L489) +Defined in: [packages/core/src/types.ts:489](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L489) Registered interceptors @@ -69,7 +69,7 @@ Registered interceptors > `readonly` **isRunning**: `boolean` -Defined in: [packages/core/src/types.ts:366](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L366) +Defined in: [packages/core/src/types.ts:366](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L366) 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:494](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L494) +Defined in: [packages/core/src/types.ts:494](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L494) Registered protocols @@ -89,7 +89,7 @@ Registered protocols > `readonly` **routes**: readonly [`ServiceRoute`](../type-aliases/ServiceRoute.md)[] -Defined in: [packages/core/src/types.ts:484](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L484) +Defined in: [packages/core/src/types.ts:484](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L484) Registered service routes @@ -99,7 +99,7 @@ Registered service routes > `readonly` **shutdownSignal**: `AbortSignal` -Defined in: [packages/core/src/types.ts:468](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L468) +Defined in: [packages/core/src/types.ts:468](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L468) 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:371](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L371) +Defined in: [packages/core/src/types.ts:371](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L371) 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:479](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L479) +Defined in: [packages/core/src/types.ts:479](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L479) Underlying transport server @@ -134,7 +134,7 @@ Returns null until server is started > `optional` **\[captureRejectionSymbol\]**(`error`, `event`, ...`args`): `void` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:123 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:87 The `Symbol.for('nodejs.rejection')` method is called in case a promise rejection happens when emitting an event and @@ -193,7 +193,7 @@ v13.4.0, v12.16.0 > **addInterceptor**(`interceptor`): `void` -Defined in: [packages/core/src/types.ts:420](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L420) +Defined in: [packages/core/src/types.ts:420](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L420) Add an interceptor at runtime @@ -217,7 +217,7 @@ Error if server is already running > **addListener**\<`E`\>(`eventName`, `listener`): `this` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:128 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:92 Alias for `emitter.on(eventName, listener)`. @@ -255,7 +255,7 @@ v0.1.26 > **addProtocol**(`protocol`): `void` -Defined in: [packages/core/src/types.ts:427](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L427) +Defined in: [packages/core/src/types.ts:427](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L427) 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:413](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L413) +Defined in: [packages/core/src/types.ts:413](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L413) Add a service route at runtime @@ -303,7 +303,7 @@ Error if server is already running > **emit**\<`E`\>(`eventName`, ...`args`): `boolean` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:170 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:134 Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments @@ -378,7 +378,7 @@ v0.1.26 > **eventNames**(): (`string` \| `symbol`)[] -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:190 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:154 Returns an array listing the events for which the emitter has registered listeners. @@ -415,7 +415,7 @@ v6.0.0 > **getMaxListeners**(): `number` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:197 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:161 Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to @@ -439,7 +439,7 @@ v1.0.0 > **listenerCount**\<`E`\>(`eventName`, `listener?`): `number` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:206 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:170 Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found @@ -483,7 +483,7 @@ v3.2.0 > **listeners**\<`E`\>(`eventName`): (...`args`) => `void`[] -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:222 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:186 Returns a copy of the array of listeners for the event named `eventName`. @@ -527,7 +527,7 @@ v0.1.26 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L398) +Defined in: [packages/core/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L398) Remove listener for lifecycle events @@ -553,7 +553,7 @@ Remove listener for lifecycle events > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:399](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L399) +Defined in: [packages/core/src/types.ts:399](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L399) Alias for `emitter.removeListener()`. @@ -583,7 +583,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:400](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L400) +Defined in: [packages/core/src/types.ts:400](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L400) Alias for `emitter.removeListener()`. @@ -613,7 +613,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:401](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L401) +Defined in: [packages/core/src/types.ts:401](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L401) Alias for `emitter.removeListener()`. @@ -643,7 +643,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:402](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L402) +Defined in: [packages/core/src/types.ts:402](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L402) Alias for `emitter.removeListener()`. @@ -677,7 +677,7 @@ v10.0.0 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:380](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L380) +Defined in: [packages/core/src/types.ts:380](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L380) Register listener for lifecycle events @@ -703,7 +703,7 @@ Register listener for lifecycle events > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:381](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L381) +Defined in: [packages/core/src/types.ts:381](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L381) 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 @@ -762,7 +762,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:382](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L382) +Defined in: [packages/core/src/types.ts:382](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L382) 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 @@ -821,7 +821,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L383) +Defined in: [packages/core/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L383) 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 @@ -880,7 +880,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:384](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L384) +Defined in: [packages/core/src/types.ts:384](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L384) 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 @@ -943,7 +943,7 @@ v0.1.101 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L389) +Defined in: [packages/core/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L389) Register one-time listener for lifecycle events @@ -969,7 +969,7 @@ Register one-time listener for lifecycle events > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:390](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L390) +Defined in: [packages/core/src/types.ts:390](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L390) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1025,7 +1025,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:391](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L391) +Defined in: [packages/core/src/types.ts:391](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L391) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1081,7 +1081,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:392](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L392) +Defined in: [packages/core/src/types.ts:392](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L392) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1137,7 +1137,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:393](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L393) +Defined in: [packages/core/src/types.ts:393](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L393) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1197,7 +1197,7 @@ v0.3.0 > **onShutdown**(`handler`): `void` -Defined in: [packages/core/src/types.ts:439](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L439) +Defined in: [packages/core/src/types.ts:439](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L439) Register an anonymous shutdown hook @@ -1221,7 +1221,7 @@ Error if server is already stopped > **onShutdown**(`name`, `handler`): `void` -Defined in: [packages/core/src/types.ts:448](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L448) +Defined in: [packages/core/src/types.ts:448](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L448) Register a named shutdown hook @@ -1251,7 +1251,7 @@ Error if server is already stopped > **onShutdown**(`name`, `dependencies`, `handler`): `void` -Defined in: [packages/core/src/types.ts:460](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L460) +Defined in: [packages/core/src/types.ts:460](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L460) Register a named shutdown hook with dependencies @@ -1291,7 +1291,7 @@ Error if server is already stopped > **prependListener**\<`E`\>(`eventName`, `listener`): `this` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:311 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:275 Adds the `listener` function to the _beginning_ of the listeners array for the event named `eventName`. No checks are made to see if the `listener` has @@ -1345,7 +1345,7 @@ v6.0.0 > **prependOnceListener**\<`E`\>(`eventName`, `listener`): `this` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:328 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:292 Adds a **one-time** `listener` function for the event named `eventName` to the _beginning_ of the listeners array. The next time `eventName` is triggered, this @@ -1397,7 +1397,7 @@ v6.0.0 > **rawListeners**\<`E`\>(`eventName`): (...`args`) => `void`[] -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:362 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:326 Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). @@ -1457,7 +1457,7 @@ v9.4.0 > **removeAllListeners**\<`E`\>(`eventName?`): `this` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:374 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:338 Removes all listeners, or those of the specified `eventName`. @@ -1497,7 +1497,7 @@ v0.1.26 > **removeListener**\<`E`\>(`eventName`, `listener`): `this` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:461 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:425 Removes the specified `listener` from the listener array for the event named `eventName`. @@ -1617,7 +1617,7 @@ v0.1.26 > **setMaxListeners**(`n`): `this` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/events.d.ts:472 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/events.d.ts:436 By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding @@ -1651,7 +1651,7 @@ v0.3.5 > **start**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L343) +Defined in: [packages/core/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L343) Start the server @@ -1669,7 +1669,7 @@ Error if server is not in CREATED state > **stop**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:350](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L350) +Defined in: [packages/core/src/types.ts:350](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L350) Stop the server gracefully diff --git a/en/api/@connectum/core/types/interfaces/ShutdownOptions.md b/en/api/@connectum/core/types/interfaces/ShutdownOptions.md index 2128553..8d38c6a 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:183](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L183) +Defined in: [packages/core/src/types.ts:183](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L183) Graceful shutdown options @@ -12,7 +12,7 @@ Graceful shutdown options > `optional` **autoShutdown?**: `boolean` -Defined in: [packages/core/src/types.ts:200](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L200) +Defined in: [packages/core/src/types.ts:200](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L200) Enable automatic graceful shutdown on signals @@ -28,7 +28,7 @@ false > `optional` **forceCloseOnTimeout?**: `boolean` -Defined in: [packages/core/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L208) +Defined in: [packages/core/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L208) 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:194](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L194) +Defined in: [packages/core/src/types.ts:194](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L194) 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:188](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L188) +Defined in: [packages/core/src/types.ts:188](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L188) 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 5123134..613565f 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:98](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L98) +Defined in: [packages/core/src/types.ts:98](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L98) TLS configuration options @@ -12,7 +12,7 @@ TLS configuration options > `optional` **certPath?**: `string` -Defined in: [packages/core/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L107) +Defined in: [packages/core/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L107) Path to TLS certificate file @@ -22,7 +22,7 @@ Path to TLS certificate file > `optional` **dirPath?**: `string` -Defined in: [packages/core/src/types.ts:113](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L113) +Defined in: [packages/core/src/types.ts:113](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L113) 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:102](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L102) +Defined in: [packages/core/src/types.ts:102](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L102) 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 f24e2ca..63f157c 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:61](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L61) +Defined in: [packages/core/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L61) 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 7d9d515..06a8422 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:165](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L165) +Defined in: [packages/core/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L165) 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 36ed91c..c8ed697 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:19](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L19) +Defined in: [packages/core/src/types.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L19) 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 797476d..e2a1ffd 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:22](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L22) +Defined in: [packages/core/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L22) 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 4fa814a..71d9631 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:147](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L147) +Defined in: [packages/core/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L147) Server state constants diff --git a/en/api/@connectum/core/types/type-aliases/ServiceRoute.md b/en/api/@connectum/core/types/type-aliases/ServiceRoute.md index d03d106..ec5aabf 100644 --- a/en/api/@connectum/core/types/type-aliases/ServiceRoute.md +++ b/en/api/@connectum/core/types/type-aliases/ServiceRoute.md @@ -4,7 +4,7 @@ > **ServiceRoute** = (`router`) => `void` -Defined in: [packages/core/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L32) +Defined in: [packages/core/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L32) Service route function diff --git a/en/api/@connectum/core/types/type-aliases/ShutdownHook.md b/en/api/@connectum/core/types/type-aliases/ShutdownHook.md index 50e67e0..3ab0246 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:39](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L39) +Defined in: [packages/core/src/types.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L39) 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 37d7d11..0b18efa 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:25](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L25) +Defined in: [packages/core/src/types.ts:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L25) 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 583a503..fdc874e 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:165](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L165) +Defined in: [packages/core/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L165) Lifecycle event names diff --git a/en/api/@connectum/core/types/variables/ServerState.md b/en/api/@connectum/core/types/variables/ServerState.md index 68007a5..b41b0d4 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:147](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/types.ts#L147) +Defined in: [packages/core/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L147) Server state constants diff --git a/en/api/@connectum/core/variables/BooleanFromStringSchema.md b/en/api/@connectum/core/variables/BooleanFromStringSchema.md index 2326b37..b60fe9f 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L35) +Defined in: [packages/core/src/config/envSchema.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 d6d465d..35a9189 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L53) +Defined in: [packages/core/src/config/envSchema.ts:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L53) Connectum environment configuration schema diff --git a/en/api/@connectum/core/variables/LogFormatSchema.md b/en/api/@connectum/core/variables/LogFormatSchema.md index 0d370b0..9565e58 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L20) +Defined in: [packages/core/src/config/envSchema.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 6f84092..69c7b97 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L15) +Defined in: [packages/core/src/config/envSchema.ts:15](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 a492c68..3767bb9 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L25) +Defined in: [packages/core/src/config/envSchema.ts:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 d96eabc..9166103 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/config/envSchema.ts#L30) +Defined in: [packages/core/src/config/envSchema.ts:30](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L30) Node environment schema diff --git a/en/api/@connectum/core/variables/tlsPath.md b/en/api/@connectum/core/variables/tlsPath.md index 3191682..2c3b052 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/core/src/TLSConfig.ts#L63) +Defined in: [packages/core/src/TLSConfig.ts:63](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/TLSConfig.ts#L63) Exported for backward compatibility diff --git a/en/api/@connectum/events-amqp/functions/AmqpAdapter.md b/en/api/@connectum/events-amqp/functions/AmqpAdapter.md index 9ba2b86..7f1cbba 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: [AmqpAdapter.ts:77](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/AmqpAdapter.ts#L77) +Defined in: [AmqpAdapter.ts:77](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/AmqpAdapter.ts#L77) 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 f923225..41ef11c 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: [AmqpAdapter.ts:35](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/AmqpAdapter.ts#L35) +Defined in: [AmqpAdapter.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/AmqpAdapter.ts#L35) 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 9a1de7f..f47f065 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: [types.ts:10](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L10) +Defined in: [types.ts:10](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L50) Consumer options. @@ -22,7 +22,7 @@ Consumer options. > `readonly` `optional` **exchange?**: `string` -Defined in: [types.ts:28](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L28) +Defined in: [types.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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: [types.ts:40](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L40) +Defined in: [types.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L40) Exchange assertion options. @@ -48,7 +48,7 @@ Exchange assertion options. > `readonly` `optional` **exchangeType?**: `"topic"` \| `"direct"` \| `"fanout"` \| `"headers"` -Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L35) +Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L35) Exchange type. @@ -64,7 +64,7 @@ Exchange type. > `readonly` `optional` **publisherOptions?**: [`AmqpPublisherOptions`](AmqpPublisherOptions.md) -Defined in: [types.ts:55](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L55) +Defined in: [types.ts:55](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L55) Publisher options. @@ -74,7 +74,7 @@ Publisher options. > `readonly` `optional` **queueOptions?**: [`AmqpQueueOptions`](AmqpQueueOptions.md) -Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L45) +Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L45) Default queue assertion options. @@ -84,7 +84,7 @@ Default queue assertion options. > `readonly` `optional` **socketOptions?**: `Record`\<`string`, `unknown`\> -Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L21) Socket options passed to `amqplib.connect()`. @@ -94,7 +94,7 @@ Socket options passed to `amqplib.connect()`. > `readonly` **url**: `string` -Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L16) AMQP connection URL. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md index 95b092b..14b9973 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: [types.ts:112](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L112) +Defined in: [types.ts:112](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L112) Consumer options. @@ -12,7 +12,7 @@ Consumer options. > `readonly` `optional` **exclusive?**: `boolean` -Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L126) +Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L126) Whether the consumer is exclusive to this connection. @@ -28,7 +28,7 @@ false > `readonly` `optional` **prefetch?**: `number` -Defined in: [types.ts:119](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L119) +Defined in: [types.ts:119](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L119) Prefetch count (QoS) — how many unacknowledged messages a consumer can have at a time. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md index e2bf872..e0b8489 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: [types.ts:61](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L61) +Defined in: [types.ts:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L61) Exchange assertion options. @@ -12,7 +12,7 @@ Exchange assertion options. > `readonly` `optional` **autoDelete?**: `boolean` -Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L74) +Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L74) Whether the exchange is deleted when the last queue unbinds. @@ -28,7 +28,7 @@ false > `readonly` `optional` **durable?**: `boolean` -Defined in: [types.ts:67](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L67) +Defined in: [types.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L67) Whether the exchange should survive broker restarts. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md index 41ad69e..6ca39d7 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: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L132) +Defined in: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L132) Publisher options. @@ -12,7 +12,7 @@ Publisher options. > `readonly` `optional` **mandatory?**: `boolean` -Defined in: [types.ts:145](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L145) +Defined in: [types.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L145) Whether the message should be returned if it cannot be routed. @@ -28,7 +28,7 @@ false > `readonly` `optional` **persistent?**: `boolean` -Defined in: [types.ts:138](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L138) +Defined in: [types.ts:138](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L138) Whether messages should be persisted to disk (deliveryMode=2). diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md index 6280099..19d36b1 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: [types.ts:80](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L80) +Defined in: [types.ts:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L80) Queue assertion options. @@ -12,7 +12,7 @@ Queue assertion options. > `readonly` `optional` **deadLetterExchange?**: `string` -Defined in: [types.ts:101](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L101) +Defined in: [types.ts:101](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L101) Dead letter exchange name for rejected messages. @@ -22,7 +22,7 @@ Dead letter exchange name for rejected messages. > `readonly` `optional` **deadLetterRoutingKey?**: `string` -Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L106) +Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L106) Dead letter routing key for rejected messages. @@ -32,7 +32,7 @@ Dead letter routing key for rejected messages. > `readonly` `optional` **durable?**: `boolean` -Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L86) +Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L86) Whether the queue should survive broker restarts. @@ -48,7 +48,7 @@ true > `readonly` `optional` **maxLength?**: `number` -Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L96) Maximum number of messages in the queue. @@ -58,6 +58,6 @@ Maximum number of messages in the queue. > `readonly` `optional` **messageTtl?**: `number` -Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-amqp/src/types.ts#L91) +Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L91) Per-message TTL in milliseconds. diff --git a/en/api/@connectum/events-kafka/functions/KafkaAdapter.md b/en/api/@connectum/events-kafka/functions/KafkaAdapter.md index 4408736..86d8b36 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/KafkaAdapter.ts#L122) +Defined in: [KafkaAdapter.ts:122](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 e0f8588..43bc6ed 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/types.ts#L17) +Defined in: [types.ts:17](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/types.ts#L23) +Defined in: [types.ts:23](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-kafka/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 f6e91f2..38cea4e 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/NatsAdapter.ts#L83) +Defined in: [NatsAdapter.ts:83](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 e58b518..423be02 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L35) +Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L24) +Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 b55db0a..346784d 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L41) +Defined in: [types.ts:41](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-nats/src/types.ts#L66) +Defined in: [types.ts:66](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 6219e1f..44007e0 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/RedisAdapter.ts#L68) +Defined in: [RedisAdapter.ts:68](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 40e5afd..0ee5c33 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L19) +Defined in: [types.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 9ccd155..d5ab441 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L63) +Defined in: [types.ts:63](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events-redis/src/types.ts#L46) +Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 fb7087d..bb928e8 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventRouter.ts#L17) +Defined in: [packages/events/src/EventRouter.ts:17](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventRouter.ts#L18) +Defined in: [packages/events/src/EventRouter.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventRouter.ts#L19) +Defined in: [packages/events/src/EventRouter.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventRouter.ts#L21) +Defined in: [packages/events/src/EventRouter.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 fd29a88..554ca5e 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L27) +Defined in: [packages/events/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L30) +Defined in: [packages/events/src/errors.ts:30](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L28) +Defined in: [packages/events/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L28) *** @@ -108,7 +108,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:67 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:67 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -130,7 +130,7 @@ not capture any frames. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:51 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:51 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L39) +Defined in: [packages/events/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L39) Check if an error is branded as non-retryable. Works across realms (Symbol.for is global). @@ -245,7 +245,7 @@ Works across realms (Symbol.for is global). > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:55 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:55 #### Parameters diff --git a/en/api/@connectum/events/classes/RetryableError.md b/en/api/@connectum/events/classes/RetryableError.md index 5f58e5b..0897591 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L56) +Defined in: [packages/events/src/errors.ts:56](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L59) +Defined in: [packages/events/src/errors.ts:59](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L57) +Defined in: [packages/events/src/errors.ts:57](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L57) *** @@ -108,7 +108,7 @@ Defined in: node\_modules/.pnpm/typescript@5.9.3/node\_modules/typescript/lib/li > `static` **stackTraceLimit**: `number` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:67 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:67 The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or @@ -130,7 +130,7 @@ not capture any frames. > `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:51 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:51 Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which @@ -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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/errors.ts#L68) +Defined in: [packages/events/src/errors.ts:68](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L68) Check if an error is branded as retryable. Works across realms (Symbol.for is global). @@ -245,7 +245,7 @@ Works across realms (Symbol.for is global). > `static` **prepareStackTrace**(`err`, `stackTraces`): `any` -Defined in: node\_modules/.pnpm/@types+node@25.3.3/node\_modules/@types/node/globals.d.ts:55 +Defined in: node\_modules/.pnpm/@types+node@25.6.0/node\_modules/@types/node/globals.d.ts:55 #### Parameters diff --git a/en/api/@connectum/events/functions/MemoryAdapter.md b/en/api/@connectum/events/functions/MemoryAdapter.md index 5e4a65c..fe92794 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/MemoryAdapter.ts#L23) +Defined in: [packages/events/src/MemoryAdapter.ts:23](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 ac06a87..2ae0d44 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/middleware.ts#L24) +Defined in: [packages/events/src/middleware.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/middleware.ts#L24) Compose an array of middleware into a single handler. diff --git a/en/api/@connectum/events/functions/createEventBus.md b/en/api/@connectum/events/functions/createEventBus.md index 356e811..2ae48ab 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventBus.ts#L71) +Defined in: [packages/events/src/EventBus.ts:71](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventBus.ts#L71) Create an EventBus instance. diff --git a/en/api/@connectum/events/functions/createEventContext.md b/en/api/@connectum/events/functions/createEventContext.md index fdca550..d94899d 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventContext.ts#L18) +Defined in: [packages/events/src/EventContext.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 c469f39..fe73c87 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/EventBus.ts#L41) +Defined in: [packages/events/src/EventBus.ts:41](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventBus.ts#L41) 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 1c10c2c..1494db9 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/middleware/dlq.ts#L29) +Defined in: [packages/events/src/middleware/dlq.ts:29](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 ba7d38d..b9b4688 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/wildcard.ts#L27) +Defined in: [packages/events/src/wildcard.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 1df318d..cb10294 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/topic.ts#L22) +Defined in: [packages/events/src/topic.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 44da834..7432a0f 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/middleware/retry.ts#L48) +Defined in: [packages/events/src/middleware/retry.ts:48](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/middleware/retry.ts#L48) Create a retry middleware with configurable options. diff --git a/en/api/@connectum/events/types/interfaces/AdapterContext.md b/en/api/@connectum/events/types/interfaces/AdapterContext.md index 6738384..1136917 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:80](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L80) +Defined in: [packages/events/src/types.ts:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L80) 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:90](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L90) +Defined in: [packages/events/src/types.ts:90](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L90) 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 3f54ad2..d4d4757 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:269](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L269) +Defined in: [packages/events/src/types.ts:269](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L269) 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:278](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L278) +Defined in: [packages/events/src/types.ts:278](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L278) 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:271](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L271) +Defined in: [packages/events/src/types.ts:271](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L271) DLQ topic name diff --git a/en/api/@connectum/events/types/interfaces/EventAdapter.md b/en/api/@connectum/events/types/interfaces/EventAdapter.md index a62fd16..820825b 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:99](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L99) +Defined in: [packages/events/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L99) 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:101](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L101) +Defined in: [packages/events/src/types.ts:101](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L101) 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:110](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L110) +Defined in: [packages/events/src/types.ts:110](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L110) 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:113](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L113) +Defined in: [packages/events/src/types.ts:113](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L113) 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:116](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L116) +Defined in: [packages/events/src/types.ts:116](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L116) 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:119](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L119) +Defined in: [packages/events/src/types.ts:119](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L119) 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 adbc4d7..59d612b 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:333](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L333) +Defined in: [packages/events/src/types.ts:333](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L333) 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:347](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L347) +Defined in: [packages/events/src/types.ts:347](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L347) Publish a typed event @@ -46,7 +46,7 @@ Publish a typed event > **start**(`options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L343) +Defined in: [packages/events/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L343) 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:345](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L345) +Defined in: [packages/events/src/types.ts:345](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L345) 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 509a7cd..2f5343b 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:296](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L296) +Defined in: [packages/events/src/types.ts:296](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L296) 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:298](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L298) +Defined in: [packages/events/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L298) 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:327](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L327) +Defined in: [packages/events/src/types.ts:327](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L327) 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:302](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L302) +Defined in: [packages/events/src/types.ts:302](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L302) Consumer group name @@ -46,7 +46,7 @@ Consumer group name > `optional` **handlerTimeout?**: `number` -Defined in: [packages/events/src/types.ts:319](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L319) +Defined in: [packages/events/src/types.ts:319](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L319) 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:304](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L304) +Defined in: [packages/events/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L304) Middleware configuration @@ -69,7 +69,7 @@ Middleware configuration > `optional` **routes?**: [`EventRoute`](../type-aliases/EventRoute.md)[] -Defined in: [packages/events/src/types.ts:300](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L300) +Defined in: [packages/events/src/types.ts:300](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L300) Event routes to register @@ -79,7 +79,7 @@ Event routes to register > `optional` **signal?**: `AbortSignal` -Defined in: [packages/events/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L312) +Defined in: [packages/events/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L312) Abort signal for graceful shutdown. diff --git a/en/api/@connectum/events/types/interfaces/EventContext.md b/en/api/@connectum/events/types/interfaces/EventContext.md index fe66b14..3ddc3cb 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:133](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L133) +Defined in: [packages/events/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L133) 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:143](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L143) +Defined in: [packages/events/src/types.ts:143](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L143) Delivery attempt number (1-based) @@ -26,7 +26,7 @@ Delivery attempt number (1-based) > `readonly` **eventId**: `string` -Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L137) +Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L137) Unique event identifier @@ -36,7 +36,7 @@ Unique event identifier > `readonly` **eventType**: `string` -Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L139) +Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L139) Event type / topic name @@ -46,7 +46,7 @@ Event type / topic name > `readonly` **metadata**: `ReadonlyMap`\<`string`, `string`\> -Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L145) +Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L145) Event metadata (headers) @@ -56,7 +56,7 @@ Event metadata (headers) > `readonly` **publishedAt**: `Date` -Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L141) +Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L141) When the event was published @@ -66,7 +66,7 @@ When the event was published > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L135) +Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L135) 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:147](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L147) +Defined in: [packages/events/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L147) Acknowledge successful processing @@ -90,7 +90,7 @@ Acknowledge successful processing > **nack**(`requeue?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:149](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L149) +Defined in: [packages/events/src/types.ts:149](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L149) 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 a5fb324..c46419a 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:155](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L155) +Defined in: [packages/events/src/types.ts:155](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L155) 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:158](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L158) +Defined in: [packages/events/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L158) #### Returns @@ -24,7 +24,7 @@ Defined in: [packages/events/src/types.ts:158](https://github.com/Connectum-Fram > `readonly` **onNack**: (`requeue`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:159](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L159) +Defined in: [packages/events/src/types.ts:159](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L159) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/events/src/types.ts:159](https://github.com/Connectum-Fram > `readonly` **raw**: [`RawEvent`](RawEvent.md) -Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L156) +Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L156) *** @@ -50,4 +50,4 @@ Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Fram > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L157) +Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L157) diff --git a/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md b/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md index a5c3228..4b1fb6e 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:178](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L178) +Defined in: [packages/events/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L178) 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:180](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L180) +Defined in: [packages/events/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L180) 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:182](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L182) +Defined in: [packages/events/src/types.ts:182](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L182) 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 a5c9bb7..1dd6b38 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:199](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L199) +Defined in: [packages/events/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L199) 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:205](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L205) +Defined in: [packages/events/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L205) Typed handler function @@ -22,7 +22,7 @@ Typed handler function > `readonly` **method**: `DescMethod` -Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L203) +Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L203) 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:207](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L207) +Defined in: [packages/events/src/types.ts:207](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L207) 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:201](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L201) +Defined in: [packages/events/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L201) 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 a1b8f60..f5517eb 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:216](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L216) +Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L216) 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:218](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L218) +Defined in: [packages/events/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L218) 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 02f2890..ffaad03 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L43) +Defined in: [packages/events/src/types.ts:43](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L45) +Defined in: [packages/events/src/types.ts:45](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 017a56b..0eda30a 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:284](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L284) +Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L284) 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:290](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L290) +Defined in: [packages/events/src/types.ts:290](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L290) 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:288](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L288) +Defined in: [packages/events/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L288) Dead letter queue configuration @@ -32,6 +32,6 @@ Dead letter queue configuration > `optional` **retry?**: [`RetryOptions`](RetryOptions.md) -Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L286) +Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L286) Retry configuration diff --git a/en/api/@connectum/events/types/interfaces/PublishOptions.md b/en/api/@connectum/events/types/interfaces/PublishOptions.md index df1712e..c8fe883 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L59) +Defined in: [packages/events/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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:65](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L65) +Defined in: [packages/events/src/types.ts:65](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L65) 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:69](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L69) +Defined in: [packages/events/src/types.ts:69](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L69) 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:67](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L67) +Defined in: [packages/events/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L67) Additional metadata / headers @@ -42,7 +42,7 @@ Additional metadata / headers > `optional` **sync?**: `boolean` -Defined in: [packages/events/src/types.ts:63](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L63) +Defined in: [packages/events/src/types.ts:63](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L63) Wait for broker confirmation (default: false = fire-and-forget) @@ -52,6 +52,6 @@ Wait for broker confirmation (default: false = fire-and-forget) > `optional` **topic?**: `string` -Defined in: [packages/events/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L61) +Defined in: [packages/events/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 916436e..564e168 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L16) +Defined in: [packages/events/src/types.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L26) +Defined in: [packages/events/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L18) +Defined in: [packages/events/src/types.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L20) +Defined in: [packages/events/src/types.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L28) +Defined in: [packages/events/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L22) +Defined in: [packages/events/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L24) +Defined in: [packages/events/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 8d273a2..0869013 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L51) +Defined in: [packages/events/src/types.ts:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L53) +Defined in: [packages/events/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 58d5f8f..34c56fe 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:251](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L251) +Defined in: [packages/events/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L251) Retry middleware options @@ -12,7 +12,7 @@ Retry middleware options > `optional` **backoff?**: `"fixed"` \| `"exponential"` \| `"linear"` -Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L255) +Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L255) Backoff strategy @@ -22,7 +22,7 @@ Backoff strategy > `optional` **initialDelay?**: `number` -Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L257) +Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L257) 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:259](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L259) +Defined in: [packages/events/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L259) 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:253](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L253) +Defined in: [packages/events/src/types.ts:253](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L253) Maximum retry attempts (default: 3) @@ -52,7 +52,7 @@ Maximum retry attempts (default: 3) > `optional` **multiplier?**: `number` -Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L261) +Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L261) 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:263](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L263) +Defined in: [packages/events/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L263) 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 c3efed1..c629a70 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:242](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L242) +Defined in: [packages/events/src/types.ts:242](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L242) 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 56ad334..b9ca58f 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:237](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L237) +Defined in: [packages/events/src/types.ts:237](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L237) 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 7ae8c2f..885b0a3 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:224](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L224) +Defined in: [packages/events/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L224) 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 9e1252c..6e7863b 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L38) +Defined in: [packages/events/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 57959b7..2f67122 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:192](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L192) +Defined in: [packages/events/src/types.ts:192](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L192) 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 535543a..cd1e5ca 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:169](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/events/src/types.ts#L169) +Defined in: [packages/events/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L169) 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 4e64725..39543a1 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:26](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L26) +Defined in: [HealthcheckManager.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L26) Healthcheck manager @@ -34,7 +34,7 @@ healthcheckManager.update(ServingStatus.SERVING); > **areAllHealthy**(): `boolean` -Defined in: [HealthcheckManager.ts:80](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L80) +Defined in: [HealthcheckManager.ts:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L80) Check if all services are healthy (SERVING) @@ -50,7 +50,7 @@ True if all services are SERVING > **clear**(): `void` -Defined in: [HealthcheckManager.ts:108](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L108) +Defined in: [HealthcheckManager.ts:108](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L108) Clear all services @@ -64,7 +64,7 @@ Clear all services > **getAllStatuses**(): `Map`\<`string`, [`ServiceStatus`](../types/interfaces/ServiceStatus.md)\> -Defined in: [HealthcheckManager.ts:71](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L71) +Defined in: [HealthcheckManager.ts:71](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L71) Get all services health status @@ -80,7 +80,7 @@ Map of service name to health status > **getStatus**(`service`): [`ServiceStatus`](../types/interfaces/ServiceStatus.md) \| `undefined` -Defined in: [HealthcheckManager.ts:62](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L62) +Defined in: [HealthcheckManager.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L62) Get service health status @@ -104,7 +104,7 @@ Service status or undefined if not found > **initialize**(`serviceNames`): `void` -Defined in: [HealthcheckManager.ts:96](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L96) +Defined in: [HealthcheckManager.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L96) Initialize services map @@ -130,7 +130,7 @@ Array of service names to track > **update**(`status`, `service?`): `void` -Defined in: [HealthcheckManager.ts:39](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L39) +Defined in: [HealthcheckManager.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L39) 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 3966d83..7ab0f58 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/Healthcheck.ts#L84) +Defined in: [Healthcheck.ts:84](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 da043e8..f643168 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:118](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/HealthcheckManager.ts#L118) +Defined in: [HealthcheckManager.ts:118](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L118) 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 fd0f2e8..c3d21e7 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/httpHandler.ts#L58) +Defined in: [httpHandler.ts:58](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 4d9b916..5cde3c4 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/httpHandler.ts#L111) +Defined in: [httpHandler.ts:111](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 c1e3fd5..99dc1ee 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L51) +Defined in: [types.ts:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L44) +Defined in: [types.ts:44](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 0fae118..194a85e 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L20) +Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 0668845..a62f70a 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 ecb7ec9..e3cbe67 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 759c052..63e4f25 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/healthcheck/src/Healthcheck.ts#L41) +Defined in: [Healthcheck.ts:41](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 8567e7d..25f7552 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/bulkhead.ts#L56) +Defined in: [bulkhead.ts:56](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 b1efc93..5973b68 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:61](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/circuit-breaker.ts#L61) +Defined in: [circuit-breaker.ts:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/circuit-breaker.ts#L61) Create circuit breaker interceptor diff --git a/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md b/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md index 8586223..11281d2 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:129](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L129) +Defined in: [defaults.ts:129](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L129) Creates the default interceptor chain with the specified configuration. diff --git a/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md b/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md index bafca1c..13f39cc 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:33](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L33) +Defined in: [defaults.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L33) Configuration options for the default interceptor chain. @@ -20,7 +20,7 @@ All interceptors are enabled by default except fallback and serializer > `optional` **bulkhead?**: `boolean` \| [`BulkheadOptions`](../../interfaces/BulkheadOptions.md) -Defined in: [defaults.ts:53](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L53) +Defined in: [defaults.ts:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L53) Bulkhead interceptor. Limits concurrent requests to prevent resource exhaustion. @@ -37,7 +37,7 @@ true (10/10) > `optional` **circuitBreaker?**: `boolean` \| [`CircuitBreakerOptions`](../../interfaces/CircuitBreakerOptions.md) -Defined in: [defaults.ts:60](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L60) +Defined in: [defaults.ts:60](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L60) Circuit breaker interceptor. Prevents cascading failures by breaking circuit on consecutive errors. @@ -54,7 +54,7 @@ true (5 failures) > `optional` **errorHandler?**: `boolean` \| [`ErrorHandlerOptions`](../../interfaces/ErrorHandlerOptions.md) -Defined in: [defaults.ts:39](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L39) +Defined in: [defaults.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L39) Error handler interceptor (first in chain). Transforms errors into ConnectError with proper codes. @@ -71,7 +71,7 @@ true > `optional` **fallback?**: `boolean` \| [`FallbackOptions`](../../interfaces/FallbackOptions.md)\<`unknown`\> -Defined in: [defaults.ts:75](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L75) +Defined in: [defaults.ts:75](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L75) Fallback interceptor. Provides graceful degradation when service fails. @@ -89,7 +89,7 @@ false > `optional` **retry?**: `boolean` \| [`RetryOptions`](../../interfaces/RetryOptions.md) -Defined in: [defaults.ts:67](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L67) +Defined in: [defaults.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L67) Retry interceptor. Retries transient failures with exponential backoff. @@ -106,7 +106,7 @@ true (3 retries) > `optional` **serializer?**: `boolean` \| [`SerializerOptions`](../../interfaces/SerializerOptions.md) -Defined in: [defaults.ts:90](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L90) +Defined in: [defaults.ts:90](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L90) Serializer interceptor (last in chain). Auto JSON serialization for ConnectRPC responses. @@ -124,7 +124,7 @@ false > `optional` **timeout?**: `boolean` \| [`TimeoutOptions`](../../interfaces/TimeoutOptions.md) -Defined in: [defaults.ts:46](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L46) +Defined in: [defaults.ts:46](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L46) Timeout interceptor. Enforces request deadline before any processing. @@ -141,7 +141,7 @@ true (30s) > `optional` **validation?**: `boolean` -Defined in: [defaults.ts:82](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/defaults.ts#L82) +Defined in: [defaults.ts:82](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L82) 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 d372a79..d4ea593 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/errorHandler.ts#L48) +Defined in: [errorHandler.ts:48](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 9ae5195..66eb341 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/fallback.ts#L57) +Defined in: [fallback.ts:57](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 16826a5..0b24cab 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:166](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L166) +Defined in: [types.ts:166](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L166) Bulkhead interceptor options @@ -12,7 +12,7 @@ Bulkhead interceptor options > `optional` **capacity?**: `number` -Defined in: [types.ts:171](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L171) +Defined in: [types.ts:171](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L171) Maximum number of concurrent requests @@ -28,7 +28,7 @@ Maximum number of concurrent requests > `optional` **queueSize?**: `number` -Defined in: [types.ts:177](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L177) +Defined in: [types.ts:177](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L177) Maximum queue size for pending requests @@ -44,7 +44,7 @@ Maximum queue size for pending requests > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:183](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L183) +Defined in: [types.ts:183](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L183) Skip bulkhead for streaming calls diff --git a/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md b/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md index 07f616e..267898b 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L126) +Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L126) Circuit breaker interceptor options @@ -12,7 +12,7 @@ Circuit breaker interceptor options > `optional` **halfOpenAfter?**: `number` -Defined in: [types.ts:137](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L137) +Defined in: [types.ts:137](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L137) Time in milliseconds to wait before attempting to close circuit @@ -28,7 +28,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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L143) +Defined in: [types.ts:143](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L143) Skip circuit breaker for streaming calls @@ -44,7 +44,7 @@ true > `optional` **threshold?**: `number` -Defined in: [types.ts:131](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L131) +Defined in: [types.ts:131](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 280ac77..0afb08c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L33) +Defined in: [types.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L39) +Defined in: [types.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 637d179..ea44289 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:189](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L189) +Defined in: [types.ts:189](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L189) Fallback interceptor options @@ -18,7 +18,7 @@ Fallback interceptor options > **handler**: (`error`) => `T` \| `Promise`\<`T`\> -Defined in: [types.ts:193](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L193) +Defined in: [types.ts:193](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L193) Fallback function to call on error @@ -38,7 +38,7 @@ Fallback function to call on error > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:199](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L199) +Defined in: [types.ts:199](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L199) Skip fallback for streaming calls diff --git a/en/api/@connectum/interceptors/interfaces/LoggerOptions.md b/en/api/@connectum/interceptors/interfaces/LoggerOptions.md index 9e78fdb..50915b1 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L45) +Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L45) Logger interceptor options @@ -12,7 +12,7 @@ Logger interceptor options > `optional` **level?**: `"error"` \| `"debug"` \| `"info"` \| `"warn"` -Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 22b50a8..06572ea 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L91) +Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L102) +Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L108) +Defined in: [types.ts:108](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L120) +Defined in: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L114) +Defined in: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 a3e8ac7..1b7d373 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L68) +Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L79) +Defined in: [types.ts:79](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L85) +Defined in: [types.ts:85](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L73) +Defined in: [types.ts:73](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 62faa2d..1b93112 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:149](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L149) +Defined in: [types.ts:149](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L149) Timeout interceptor options @@ -12,7 +12,7 @@ Timeout interceptor options > `optional` **duration?**: `number` -Defined in: [types.ts:154](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L154) +Defined in: [types.ts:154](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L154) Request timeout in milliseconds @@ -28,7 +28,7 @@ Request timeout in milliseconds > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:160](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L160) +Defined in: [types.ts:160](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L160) 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 8b76bed..b547f3c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/logger.ts#L86) +Defined in: [logger.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 c0c5950..37c6ba7 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/method-filter.ts#L130) +Defined in: [method-filter.ts:130](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 21e3b20..c968084 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/retry.ts#L44) +Defined in: [retry.ts:44](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 6449bfa..9883825 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/serializer.ts#L84) +Defined in: [serializer.ts:84](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 8de279f..985312f 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/timeout.ts#L55) +Defined in: [timeout.ts:55](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 a8260a6..8299940 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 164f0fc..3ab4cb5 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:224](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/interceptors/src/types.ts#L224) +Defined in: [types.ts:224](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L224) 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 949bb96..d9784f9 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:38](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L38) +Defined in: [packages/otel/src/attributes.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L38) ConnectRPC error code map (numeric code -> string name) Based on Connect protocol error codes 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 aa1de29..93c70bd 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L20) +Defined in: [packages/otel/src/attributes.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 af6a050..c9c2be3 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L25) +Defined in: [packages/otel/src/attributes.ts:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 d892440..23ff1ec 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L26) +Defined in: [packages/otel/src/attributes.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 6114343..d23c9cb 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L23) +Defined in: [packages/otel/src/attributes.ts:23](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 f2e0b11..1dfb779 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L24) +Defined in: [packages/otel/src/attributes.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 d1ec1c5..c2320e1 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L19) +Defined in: [packages/otel/src/attributes.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 88eaeb5..2e32b32 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:31](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L31) +Defined in: [packages/otel/src/attributes.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L31) 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 70692e9..259db0e 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:30](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L30) +Defined in: [packages/otel/src/attributes.ts:30](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L30) 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 bb32ecc..ebd3c8d 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:32](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L32) +Defined in: [packages/otel/src/attributes.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L32) 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 b45662c..f546bbc 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L18) +Defined in: [packages/otel/src/attributes.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 89f5e75..64ad7d7 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L17) +Defined in: [packages/otel/src/attributes.ts:17](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 6c7b95b..192dbf5 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L16) +Defined in: [packages/otel/src/attributes.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 e37329f..700ac7b 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L21) +Defined in: [packages/otel/src/attributes.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 1ce557e..48ab66b 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L22) +Defined in: [packages/otel/src/attributes.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L22) diff --git a/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md b/en/api/@connectum/otel/attributes/variables/ConnectErrorCode.md index f8f61d9..d88ebd4 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:38](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L38) +Defined in: [packages/otel/src/attributes.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L38) 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 c850f32..afc2d85 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:62](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L62) +Defined in: [packages/otel/src/attributes.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L62) 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 28a2fb8..68d5264 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:29](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L29) +Defined in: [packages/otel/src/attributes.ts:29](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L29) 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 b2e1437..0777517 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/attributes.ts#L13) +Defined in: [packages/otel/src/attributes.ts:13](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 b509339..d31e1bd 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:58](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/client-interceptor.ts#L58) +Defined in: [packages/otel/src/client-interceptor.ts:58](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/client-interceptor.ts#L58) 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 4a94b7f..d1d8fa9 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L100) +Defined in: [packages/otel/src/config.ts:100](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 7388163..1e91334 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L81) +Defined in: [packages/otel/src/config.ts:81](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 a84df7e..58349cd 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L65) +Defined in: [packages/otel/src/config.ts:65](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 f13574a..2fd0758 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L116) +Defined in: [packages/otel/src/config.ts:116](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 04ed02e..8e7529e 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:51](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/interceptor.ts#L51) +Defined in: [packages/otel/src/interceptor.ts:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/interceptor.ts#L51) 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 c435033..2e6fdf6 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L48) +Defined in: [packages/otel/src/config.ts:48](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L52) +Defined in: [packages/otel/src/config.ts:52](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L49) +Defined in: [packages/otel/src/config.ts:49](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L50) +Defined in: [packages/otel/src/config.ts:50](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L51) +Defined in: [packages/otel/src/config.ts:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 8455afa..97a4fde 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L40) +Defined in: [packages/otel/src/config.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L41) +Defined in: [packages/otel/src/config.ts:41](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L42) +Defined in: [packages/otel/src/config.ts:42](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L42) diff --git a/en/api/@connectum/otel/interfaces/Meter.md b/en/api/@connectum/otel/interfaces/Meter.md index c16c881..73d8615 100644 --- a/en/api/@connectum/otel/interfaces/Meter.md +++ b/en/api/@connectum/otel/interfaces/Meter.md @@ -2,7 +2,7 @@ # Interface: Meter -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:18 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:22 An interface to allow the recording metrics. @@ -10,13 +10,17 @@ Metrics are used for recording pre-defined aggregation (`Counter`), or raw values (`Histogram`) in which the aggregation and attributes for the exported metric are deferred. +## Since + +1.3.0 + ## Methods ### addBatchObservableCallback() > **addBatchObservableCallback**\<`AttributesTypes`\>(`callback`, `observables`): `void` -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:98 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:102 Sets up a function that will be called whenever a metric collection is initiated. @@ -58,7 +62,7 @@ the observables associated with this batch observable callback > **createCounter**\<`AttributesTypes`\>(`name`, `options?`): `Counter`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:38 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:42 Creates a new `Counter` metric. Generally, this kind of metric when the value is a quantity, the sum is of primary interest, and the event count @@ -94,7 +98,7 @@ the metric options. > **createGauge**\<`AttributesTypes`\>(`name`, `options?`): `Gauge`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:24 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:28 Creates and returns a new `Gauge`. @@ -128,7 +132,7 @@ the metric options. > **createHistogram**\<`AttributesTypes`\>(`name`, `options?`): `Histogram`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:30 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:34 Creates and returns a new `Histogram`. @@ -162,7 +166,7 @@ the metric options. > **createObservableCounter**\<`AttributesTypes`\>(`name`, `options?`): `ObservableCounter`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:74 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:78 Creates a new `ObservableCounter` metric. @@ -198,7 +202,7 @@ the metric options. > **createObservableGauge**\<`AttributesTypes`\>(`name`, `options?`): `ObservableGauge`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:65 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:69 Creates a new `ObservableGauge` metric. @@ -234,7 +238,7 @@ the metric options. > **createObservableUpDownCounter**\<`AttributesTypes`\>(`name`, `options?`): `ObservableUpDownCounter`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:83 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:87 Creates a new `ObservableUpDownCounter` metric. @@ -270,7 +274,7 @@ the metric options. > **createUpDownCounter**\<`AttributesTypes`\>(`name`, `options?`): `UpDownCounter`\<`AttributesTypes`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:56 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:60 Creates a new `UpDownCounter` metric. UpDownCounter is a synchronous instrument and very similar to Counter except that Add(increment) @@ -315,7 +319,7 @@ the metric options. > **removeBatchObservableCallback**\<`AttributesTypes`\>(`callback`, `observables`): `void` -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:108 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/metrics/Meter.d.ts:112 Removes a callback previously registered with [Meter.addBatchObservableCallback](#addbatchobservablecallback). diff --git a/en/api/@connectum/otel/interfaces/OTLPSettings.md b/en/api/@connectum/otel/interfaces/OTLPSettings.md index 8551e7c..5a26f4d 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L31) +Defined in: [packages/otel/src/config.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L34) +Defined in: [packages/otel/src/config.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L33) +Defined in: [packages/otel/src/config.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L32) +Defined in: [packages/otel/src/config.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 3046579..651afaf 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L29) +Defined in: [packages/otel/src/types.ts:29](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 0c4e6b3..d65199c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L75) +Defined in: [packages/otel/src/types.ts:75](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L80) +Defined in: [packages/otel/src/types.ts:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L86) +Defined in: [packages/otel/src/types.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 e25406a..c4b89ef 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L53) +Defined in: [packages/otel/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L64) +Defined in: [packages/otel/src/types.ts:64](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L69) +Defined in: [packages/otel/src/types.ts:69](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L59) +Defined in: [packages/otel/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 2a01029..b869b6c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L133) +Defined in: [packages/otel/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L157) +Defined in: [packages/otel/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L144) +Defined in: [packages/otel/src/types.ts:144](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L141) +Defined in: [packages/otel/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L138) +Defined in: [packages/otel/src/types.ts:138](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L152) +Defined in: [packages/otel/src/types.ts:152](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 779b6af..1ac3b9a 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L104) +Defined in: [packages/otel/src/types.ts:104](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L122) +Defined in: [packages/otel/src/types.ts:122](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L127) +Defined in: [packages/otel/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L108) +Defined in: [packages/otel/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L116) +Defined in: [packages/otel/src/types.ts:116](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L116) Record function arguments as span attributes. - `false` (default): no args recorded diff --git a/en/api/@connectum/otel/interfaces/Tracer.md b/en/api/@connectum/otel/interfaces/Tracer.md index 78266a3..dcd531d 100644 --- a/en/api/@connectum/otel/interfaces/Tracer.md +++ b/en/api/@connectum/otel/interfaces/Tracer.md @@ -2,10 +2,14 @@ # Interface: Tracer -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:7 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:9 Tracer provides an interface for creating [Span](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.Span.html)s. +## Since + +1.0.0 + ## Methods ### startActiveSpan() @@ -14,7 +18,7 @@ Tracer provides an interface for creating [Span](https://open-telemetry.github.i > **startActiveSpan**\<`F`\>(`name`, `fn`): `ReturnType`\<`F`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:67 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:69 Starts a new [Span](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.Span.html) and calls the given function passing it the created span as first argument. @@ -88,7 +92,7 @@ const span = tracer.startActiveSpan('op', span => { > **startActiveSpan**\<`F`\>(`name`, `options`, `fn`): `ReturnType`\<`F`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:68 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:70 ##### Type Parameters @@ -118,7 +122,7 @@ Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentele > **startActiveSpan**\<`F`\>(`name`, `options`, `context`, `fn`): `ReturnType`\<`F`\> -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:69 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:71 ##### Type Parameters @@ -154,7 +158,7 @@ Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentele > **startSpan**(`name`, `options?`, `context?`): [`Span`](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.Span.html) -Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.0/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:22 +Defined in: node\_modules/.pnpm/@opentelemetry+api@1.9.1/node\_modules/@opentelemetry/api/build/src/trace/tracer.d.ts:24 Starts a new [Span](https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_api.Span.html). Start the span without setting it on context. diff --git a/en/api/@connectum/otel/logger/functions/getLogger.md b/en/api/@connectum/otel/logger/functions/getLogger.md index 0d38db6..cc4f195 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L28) +Defined in: [packages/otel/src/logger.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 9cdf4d8..b6afb51 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L11) +Defined in: [packages/otel/src/logger.ts:11](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L15) +Defined in: [packages/otel/src/logger.ts:15](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L16) +Defined in: [packages/otel/src/logger.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L14) +Defined in: [packages/otel/src/logger.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L12) +Defined in: [packages/otel/src/logger.ts:12](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L13) +Defined in: [packages/otel/src/logger.ts:13](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 3cf9457..9b489ef 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L7) +Defined in: [packages/otel/src/logger.ts:7](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/logger.ts#L8) +Defined in: [packages/otel/src/logger.ts:8](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 f65fb86..7712fd4 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/meter.ts#L14) +Defined in: [packages/otel/src/meter.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 7a2aaca..a53e152 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L106) +Defined in: [packages/otel/src/metrics.ts:106](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 b1d185e..8a3f3a8 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L65) +Defined in: [packages/otel/src/metrics.ts:65](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 ce18565..60dcc84 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L34) +Defined in: [packages/otel/src/metrics.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L36) +Defined in: [packages/otel/src/metrics.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L38) +Defined in: [packages/otel/src/metrics.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L40) +Defined in: [packages/otel/src/metrics.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 55caf09..18766d8 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L19) +Defined in: [packages/otel/src/metrics.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L21) +Defined in: [packages/otel/src/metrics.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L23) +Defined in: [packages/otel/src/metrics.ts:23](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/metrics.ts#L25) +Defined in: [packages/otel/src/metrics.ts:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/getProvider.md b/en/api/@connectum/otel/provider/functions/getProvider.md index e0fa208..fda745a 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:275](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L275) +Defined in: [packages/otel/src/provider.ts:275](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L275) 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 fef957d..306e68d 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:261](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L261) +Defined in: [packages/otel/src/provider.ts:261](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L261) Initialize the OpenTelemetry provider with explicit options. diff --git a/en/api/@connectum/otel/provider/functions/shutdownProvider.md b/en/api/@connectum/otel/provider/functions/shutdownProvider.md index 3c1c982..74af04d 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:288](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L288) +Defined in: [packages/otel/src/provider.ts:288](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L288) 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 0a3d0f3..479f6bb 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:31](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L31) +Defined in: [packages/otel/src/provider.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L31) Options for initializing the OpenTelemetry provider @@ -12,7 +12,7 @@ Options for initializing the OpenTelemetry provider > `optional` **serviceName?**: `string` -Defined in: [packages/otel/src/provider.ts:33](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L33) +Defined in: [packages/otel/src/provider.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L33) Override service name (defaults to OTEL_SERVICE_NAME or npm_package_name) @@ -22,7 +22,7 @@ Override service name (defaults to OTEL_SERVICE_NAME or npm_package_name) > `optional` **serviceVersion?**: `string` -Defined in: [packages/otel/src/provider.ts:35](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L35) +Defined in: [packages/otel/src/provider.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L35) Override service version (defaults to npm_package_version) @@ -32,6 +32,6 @@ Override service version (defaults to npm_package_version) > `optional` **settings?**: `Partial`\<[`OTLPSettings`](../../interfaces/OTLPSettings.md)\> -Defined in: [packages/otel/src/provider.ts:37](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/provider.ts#L37) +Defined in: [packages/otel/src/provider.ts:37](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L37) Override OTLP exporter settings (defaults to env-based config) diff --git a/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md b/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md index 65cc2d8..e3080fd 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:181](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L181) +Defined in: [packages/otel/src/shared.ts:181](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L181) 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 9a59e1c..f794664 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:158](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L158) +Defined in: [packages/otel/src/shared.ts:158](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L158) 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 2ffa5a3..2f773f2 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:129](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L129) +Defined in: [packages/otel/src/shared.ts:129](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L129) Builds error-specific attributes for spans and metrics. diff --git a/en/api/@connectum/otel/shared/functions/estimateMessageSize.md b/en/api/@connectum/otel/shared/functions/estimateMessageSize.md index 9495660..66e7ef6 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:49](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L49) +Defined in: [packages/otel/src/shared.ts:49](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L49) 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 7dd5c26..c400a89 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:81](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L81) +Defined in: [packages/otel/src/shared.ts:81](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L81) 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 7bfb10f..e138aa6 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:145](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L145) +Defined in: [packages/otel/src/shared.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L145) 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:147](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L147) +Defined in: [packages/otel/src/shared.ts:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L147) *** @@ -20,7 +20,7 @@ Defined in: [packages/otel/src/shared.ts:147](https://github.com/Connectum-Frame > **serverAddress**: `string` -Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L148) +Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L148) *** @@ -28,7 +28,7 @@ Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Frame > `optional` **serverPort?**: `number` -Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L149) +Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L149) *** @@ -36,4 +36,4 @@ Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Frame > **service**: `string` -Defined in: [packages/otel/src/shared.ts:146](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/shared.ts#L146) +Defined in: [packages/otel/src/shared.ts:146](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L146) diff --git a/en/api/@connectum/otel/traceAll/functions/traceAll.md b/en/api/@connectum/otel/traceAll/functions/traceAll.md index 312b24e..def5921 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/traceAll.ts#L36) +Defined in: [packages/otel/src/traceAll.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 03b2607..2acdda3 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/traced.ts#L31) +Defined in: [packages/otel/src/traced.ts:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 0921ba6..0681ef9 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/tracer.ts#L14) +Defined in: [packages/otel/src/tracer.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 ac84b90..6cdae2c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L94) +Defined in: [packages/otel/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 dcfb219..932b96c 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L19) +Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 1c9e695..934b504 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L99) +Defined in: [packages/otel/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 42bf755..b477712 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L24) +Defined in: [packages/otel/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 a8ae22f..eb3294f 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/types.ts#L15) +Defined in: [packages/otel/src/types.ts:15](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 11d9084..9a032b6 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/otel/src/config.ts#L19) +Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 2a154ca..c771330 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/reflection/src/Reflection.ts#L43) +Defined in: [Reflection.ts:43](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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 df8dfe9..4776fa4 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/638fd0bfcd1daf229a925892579ece032b17742c/packages/reflection/src/utils.ts#L19) +Defined in: [utils.ts:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/reflection/src/utils.ts#L19) Recursively collect FileDescriptorProto objects from DescFile entries, including transitive dependencies. diff --git a/en/api/@connectum/testing/index/functions/assertConnectError.md b/en/api/@connectum/testing/index/functions/assertConnectError.md index c5ef235..cca09c8 100644 --- a/en/api/@connectum/testing/index/functions/assertConnectError.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/assertions.ts#L44) +Defined in: [assertions.ts:44](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/testing/index/functions/createFakeMethod.md b/en/api/@connectum/testing/index/functions/createFakeMethod.md index 8e2094c..e63fd4b 100644 --- a/en/api/@connectum/testing/index/functions/createFakeMethod.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/fake-service.ts#L72) +Defined in: [fake-service.ts:72](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/fake-service.ts#L72) Create a fake DescMethod descriptor attached to a service. diff --git a/en/api/@connectum/testing/index/functions/createFakeService.md b/en/api/@connectum/testing/index/functions/createFakeService.md index 9c8a32b..d3ddd55 100644 --- a/en/api/@connectum/testing/index/functions/createFakeService.md +++ b/en/api/@connectum/testing/index/functions/createFakeService.md @@ -4,7 +4,7 @@ > **createFakeService**(`options?`): `DescService` -Defined in: [fake-service.ts:34](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/fake-service.ts#L34) +Defined in: [fake-service.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/fake-service.ts#L34) Create a fake DescService descriptor for testing. diff --git a/en/api/@connectum/testing/index/functions/createMockDescField.md b/en/api/@connectum/testing/index/functions/createMockDescField.md index 6574465..4cb3ab7 100644 --- a/en/api/@connectum/testing/index/functions/createMockDescField.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-desc.ts#L62) +Defined in: [mock-desc.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-desc.ts#L62) Create a mock DescField descriptor. diff --git a/en/api/@connectum/testing/index/functions/createMockDescMessage.md b/en/api/@connectum/testing/index/functions/createMockDescMessage.md index 0fd3cad..5f120ea 100644 --- a/en/api/@connectum/testing/index/functions/createMockDescMessage.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-desc.ts#L109) +Defined in: [mock-desc.ts:109](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-desc.ts#L109) Create a mock DescMessage descriptor with all required structural properties. diff --git a/en/api/@connectum/testing/index/functions/createMockDescMethod.md b/en/api/@connectum/testing/index/functions/createMockDescMethod.md index c84b173..1892bb6 100644 --- a/en/api/@connectum/testing/index/functions/createMockDescMethod.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-desc.ts#L172) +Defined in: [mock-desc.ts:172](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-desc.ts#L172) Create a mock DescMethod descriptor. diff --git a/en/api/@connectum/testing/index/functions/createMockFn.md b/en/api/@connectum/testing/index/functions/createMockFn.md index 3889181..aea3da8 100644 --- a/en/api/@connectum/testing/index/functions/createMockFn.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-compat.ts#L54) +Defined in: [mock-compat.ts:54](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L54) Create a portable mock function that wraps `impl` and records every call. diff --git a/en/api/@connectum/testing/index/functions/createMockNext.md b/en/api/@connectum/testing/index/functions/createMockNext.md index 00e17c4..cda27eb 100644 --- a/en/api/@connectum/testing/index/functions/createMockNext.md +++ b/en/api/@connectum/testing/index/functions/createMockNext.md @@ -4,7 +4,7 @@ > **createMockNext**(`options?`): `any` -Defined in: [mock-next.ts:36](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-next.ts#L36) +Defined in: [mock-next.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-next.ts#L36) Create a mock `next` handler that resolves with a successful response. diff --git a/en/api/@connectum/testing/index/functions/createMockNextError.md b/en/api/@connectum/testing/index/functions/createMockNextError.md index 4ac0ba5..3cc9a70 100644 --- a/en/api/@connectum/testing/index/functions/createMockNextError.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-next.ts#L68) +Defined in: [mock-next.ts:68](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-next.ts#L68) Create a mock `next` handler that always throws a ConnectError. diff --git a/en/api/@connectum/testing/index/functions/createMockNextSlow.md b/en/api/@connectum/testing/index/functions/createMockNextSlow.md index 24f6756..2d3032e 100644 --- a/en/api/@connectum/testing/index/functions/createMockNextSlow.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-next.ts#L93) +Defined in: [mock-next.ts:93](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-next.ts#L93) Create a mock `next` handler that resolves after a configurable delay. diff --git a/en/api/@connectum/testing/index/functions/createMockRequest.md b/en/api/@connectum/testing/index/functions/createMockRequest.md index 1552457..8690571 100644 --- a/en/api/@connectum/testing/index/functions/createMockRequest.md +++ b/en/api/@connectum/testing/index/functions/createMockRequest.md @@ -4,7 +4,7 @@ > **createMockRequest**(`options?`): `any` -Defined in: [mock-request.ts:34](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-request.ts#L34) +Defined in: [mock-request.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/testing/index/functions/createMockStream.md b/en/api/@connectum/testing/index/functions/createMockStream.md index 6525daf..cd3b3b3 100644 --- a/en/api/@connectum/testing/index/functions/createMockStream.md +++ b/en/api/@connectum/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-stream.ts#L35) +Defined in: [mock-stream.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-stream.ts#L35) Create an AsyncIterable that yields `items` sequentially. diff --git a/en/api/@connectum/testing/index/functions/createTestServer.md b/en/api/@connectum/testing/index/functions/createTestServer.md index 87ce6c9..d680117 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: [test-server.ts:33](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/test-server.ts#L33) +Defined in: [test-server.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/withTestServer.md b/en/api/@connectum/testing/index/functions/withTestServer.md index 8791b67..1b72617 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: [test-server.ts:93](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/test-server.ts#L93) +Defined in: [test-server.ts:93](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/MockCall.md b/en/api/@connectum/testing/index/interfaces/MockCall.md index 35d2caa..3b3d6ff 100644 --- a/en/api/@connectum/testing/index/interfaces/MockCall.md +++ b/en/api/@connectum/testing/index/interfaces/MockCall.md @@ -2,7 +2,7 @@ # Interface: MockCall\ -Defined in: [mock-compat.ts:15](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-compat.ts#L15) +Defined in: [mock-compat.ts:15](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-compat.ts#L17) +Defined in: [mock-compat.ts:17](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L17) The arguments passed to the mock function. diff --git a/en/api/@connectum/testing/index/interfaces/MockFn.md b/en/api/@connectum/testing/index/interfaces/MockFn.md index e2335aa..3f88c37 100644 --- a/en/api/@connectum/testing/index/interfaces/MockFn.md +++ b/en/api/@connectum/testing/index/interfaces/MockFn.md @@ -2,7 +2,7 @@ # Interface: MockFn()\ -Defined in: [mock-compat.ts:27](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-compat.ts#L27) +Defined in: [mock-compat.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-compat.ts#L28) +Defined in: [mock-compat.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/mock-compat.ts#L30) +Defined in: [mock-compat.ts:30](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L30) Spy metadata. diff --git a/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md b/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md index a64f0f7..465a91c 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: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L126) +Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L126) Options for createTestServer. @@ -12,7 +12,7 @@ Options for createTestServer. > `optional` **interceptors?**: `unknown`[] -Defined in: [types.ts:130](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L130) +Defined in: [types.ts:130](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L130) Interceptors to apply. Default: `[]` @@ -22,7 +22,7 @@ Interceptors to apply. Default: `[]` > `optional` **port?**: `number` -Defined in: [types.ts:134](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L134) +Defined in: [types.ts:134](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L134) Port number. Default: `0` (random available port) @@ -32,7 +32,7 @@ Port number. Default: `0` (random available port) > `optional` **protocols?**: `unknown`[] -Defined in: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L132) +Defined in: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L132) Protocol extensions (Healthcheck, Reflection). Default: `[]` @@ -42,6 +42,6 @@ Protocol extensions (Healthcheck, Reflection). Default: `[]` > **services**: `unknown`[] -Defined in: [types.ts:128](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L128) +Defined in: [types.ts:128](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L128) ConnectRPC service route handlers. diff --git a/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md b/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md index 7e41c4d..2070c92 100644 --- a/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md +++ b/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md @@ -2,7 +2,7 @@ # Interface: FakeMethodOptions -Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L102) +Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L104) +Defined in: [types.ts:104](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L106) +Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L106) Whether to register the method in service.methods. Default: `false` diff --git a/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md b/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md index 23f5b01..719dcf5 100644 --- a/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md +++ b/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md @@ -2,7 +2,7 @@ # Interface: FakeServiceOptions -Defined in: [types.ts:94](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L94) +Defined in: [types.ts:94](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L98) +Defined in: [types.ts:98](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L96) Service type name. Default: `'test.v1.TestService'` diff --git a/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md b/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md index 2a86151..4b73a66 100644 --- a/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md +++ b/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md @@ -2,7 +2,7 @@ # Interface: MockDescFieldOptions -Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L60) +Defined in: [types.ts:60](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L64) +Defined in: [types.ts:64](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L64) Field scalar type. Default: `'string'` diff --git a/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md b/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md index ab6484e..3eea736 100644 --- a/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md +++ b/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md @@ -2,7 +2,7 @@ # Interface: MockDescMessageOptions -Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L46) +Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L48) +Defined in: [types.ts:48](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L54) +Defined in: [types.ts:54](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L54) Oneof group names. Default: `[]` diff --git a/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md b/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md index 1ec2c63..8173e9d 100644 --- a/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md +++ b/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md @@ -2,7 +2,7 @@ # Interface: MockDescMethodOptions -Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L68) +Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L70) +Defined in: [types.ts:70](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L74) +Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L72) +Defined in: [types.ts:72](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L76) +Defined in: [types.ts:76](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L76) Enable sensitive field redaction for this method. Default: `false` diff --git a/en/api/@connectum/testing/types/interfaces/MockNextOptions.md b/en/api/@connectum/testing/types/interfaces/MockNextOptions.md index a366f8a..b851df2 100644 --- a/en/api/@connectum/testing/types/interfaces/MockNextOptions.md +++ b/en/api/@connectum/testing/types/interfaces/MockNextOptions.md @@ -2,7 +2,7 @@ # Interface: MockNextOptions -Defined in: [types.ts:34](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L34) +Defined in: [types.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L36) +Defined in: [types.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L38) Streaming response flag. Default: `false` diff --git a/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md b/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md index 98e226b..efd2e58 100644 --- a/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md +++ b/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md @@ -2,7 +2,7 @@ # Interface: MockRequestOptions -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L20) +Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L18) +Defined in: [types.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L22) +Defined in: [types.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L24) +Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L24) Request URL. Auto-generated from service/method if omitted. diff --git a/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md b/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md index f70b5ae..4541516 100644 --- a/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md +++ b/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md @@ -2,7 +2,7 @@ # Interface: MockStreamOptions -Defined in: [types.ts:84](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L84) +Defined in: [types.ts:84](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/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/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L86) +Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L86) Delay in milliseconds between yielded items. diff --git a/en/api/@connectum/testing/types/interfaces/TestServer.md b/en/api/@connectum/testing/types/interfaces/TestServer.md index 5a114e0..06a0128 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: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L114) +Defined in: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L114) A running test server with transport and cleanup. @@ -12,7 +12,7 @@ A running test server with transport and cleanup. > **baseUrl**: `string` -Defined in: [types.ts:118](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L118) +Defined in: [types.ts:118](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L118) Server base URL (e.g. `http://localhost:54321`). @@ -22,7 +22,7 @@ Server base URL (e.g. `http://localhost:54321`). > **port**: `number` -Defined in: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L120) +Defined in: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L120) Assigned port number. @@ -32,7 +32,7 @@ Assigned port number. > **transport**: `Transport` -Defined in: [types.ts:116](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L116) +Defined in: [types.ts:116](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L116) 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: [types.ts:122](https://github.com/Connectum-Framework/connectum/blob/638fd0bfcd1daf229a925892579ece032b17742c/packages/testing/src/types.ts#L122) +Defined in: [types.ts:122](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L122) Stop the server and close all connections. From bd98918cdc3f7a46b7c6683ee963e87d6b854968 Mon Sep 17 00:00:00 2001 From: intech Date: Tue, 5 May 2026 01:59:05 +0400 Subject: [PATCH 3/4] chore(deps): pin pnpm@11.0.4 with SHA512 integrity hash Mirror the integrity-pinned packageManager value from connectum (PR #111) for consistency across the framework's repos. SHA512 hex digest sourced from npm registry metadata for the pnpm@11.0.4 tarball. Co-Authored-By: Claude Opus 4.7 (1M context) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 97c1b98..a27cfaf 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,7 @@ "docs:build": "vitepress build", "docs:preview": "vitepress preview" }, - "packageManager": "pnpm@11.0.4", + "packageManager": "pnpm@11.0.4+sha512.0a397165007a014ed52919a61e5f46c48b9bca88404c303ecaecc63f62def563898d3c6b8a5d5ea5811eb398cfe03ab05da1a5ce963f126d5ead4c02f93b83c3", "devDependencies": { "@braintree/sanitize-url": "^7.1.2", "cytoscape": "^3.33.2", From 938ff1b0429a217bb632cea604dc1f1a26a4856a Mon Sep 17 00:00:00 2001 From: intech Date: Sat, 16 May 2026 21:44:23 +0400 Subject: [PATCH 4/4] docs: add in-process transport guide + API reference regeneration - guide: en/guide/production/in-process-transport.md (rationale, usage, parity guarantees) - update: en/packages/core.md, en/packages/otel.md, en/guide/production/architecture.md - contributing: en/contributing/parity-invariant.md, en/contributing/parity-coverage.md - API reference regenerated via TypeDoc (covers new createLocalTransport, server.client, connectum.transport OTEL attribute, and new @connectum/test-fixtures package surface) --- .../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 +- .../functions/createJwtAuthInterceptor.md | 2 +- .../functions/createProtoAuthzInterceptor.md | 2 +- .../functions/createSessionAuthInterceptor.md | 2 +- .../auth/functions/getAuthContext.md | 2 +- .../auth/functions/getPublicMethods.md | 2 +- .../auth/functions/matchesMethodPattern.md | 2 +- .../auth/functions/parseAuthHeaders.md | 2 +- .../auth/functions/requireAuthContext.md | 2 +- .../auth/functions/resolveMethodAuth.md | 2 +- .../auth/functions/setAuthHeaders.md | 2 +- .../@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 +- .../interfaces/JwtAuthInterceptorOptions.md | 22 +- .../ProtoAuthzInterceptorOptions.md | 8 +- .../auth/interfaces/ResolvedMethodAuth.md | 8 +- .../SessionAuthInterceptorOptions.md | 16 +- .../functions/createMockAuthContext.md | 2 +- .../auth/testing/functions/createTestJwt.md | 2 +- .../auth/testing/functions/withAuthContext.md | 2 +- .../auth/testing/variables/TEST_JWT_SECRET.md | 2 +- .../auth/type-aliases/AuthzEffect.md | 2 +- .../auth/type-aliases/InterceptorFactory.md | 2 +- .../@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/functions/createLocalTransport.md | 43 ++++ .../@connectum/core/functions/createServer.md | 2 +- .../@connectum/core/functions/getTLSPath.md | 2 +- .../core/functions/isSanitizableError.md | 2 +- .../core/functions/parseEnvConfig.md | 2 +- .../core/functions/readTLSCertificates.md | 2 +- .../core/functions/safeParseEnvConfig.md | 2 +- en/api/@connectum/core/index.md | 8 + .../interfaces/CreateLocalTransportOptions.md | 20 ++ .../core/interfaces/SanitizableError.md | 6 +- .../core/type-aliases/ConnectumEnv.md | 2 +- en/api/@connectum/core/types/index.md | 1 + .../types/interfaces/CreateServerOptions.md | 24 +- .../core/types/interfaces/EventBusLike.md | 6 +- .../core/types/interfaces/ProtocolContext.md | 4 +- .../types/interfaces/ProtocolRegistration.md | 8 +- .../core/types/interfaces/Server.md | 186 ++++++++++++--- .../types/interfaces/ServerClientOptions.md | 21 ++ .../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/ServiceRoute.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/LogFormatSchema.md | 2 +- .../core/variables/LogLevelSchema.md | 2 +- .../core/variables/LoggerBackendSchema.md | 2 +- .../core/variables/NodeEnvSchema.md | 2 +- en/api/@connectum/core/variables/tlsPath.md | 2 +- .../events-amqp/functions/AmqpAdapter.md | 2 +- .../events-amqp/functions/toAmqpPattern.md | 2 +- .../types/interfaces/AmqpAdapterOptions.md | 18 +- .../types/interfaces/AmqpConsumerOptions.md | 6 +- .../types/interfaces/AmqpExchangeOptions.md | 6 +- .../types/interfaces/AmqpPublisherOptions.md | 6 +- .../types/interfaces/AmqpQueueOptions.md | 12 +- .../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 +- .../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 +- .../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 | 16 +- .../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 | 12 +- .../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 | 14 +- .../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/createDefaultInterceptors.md | 2 +- .../interfaces/DefaultInterceptorOptions.md | 18 +- .../createErrorHandlerInterceptor.md | 2 +- .../functions/createFallbackInterceptor.md | 2 +- .../interfaces/BulkheadOptions.md | 8 +- .../interfaces/CircuitBreakerOptions.md | 8 +- .../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 +- en/api/@connectum/otel/attributes/index.md | 4 + .../type-aliases/ConnectErrorCode.md | 2 +- .../variables/ATTR_CONNECTUM_TRANSPORT.md | 23 ++ .../ATTR_CONNECTUM_TRANSPORT_METRIC.md | 12 + .../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 | 9 + ...CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md | 9 + .../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 +- en/api/@connectum/otel/index.md | 30 +++ .../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 +- .../otel/provider/functions/getProvider.md | 2 +- .../otel/provider/functions/initProvider.md | 2 +- .../provider/functions/shutdownProvider.md | 2 +- .../provider/interfaces/ProviderOptions.md | 8 +- .../shared/functions/applyAttributeFilter.md | 2 +- .../shared/functions/buildBaseAttributes.md | 2 +- .../shared/functions/buildErrorAttributes.md | 2 +- .../functions/detectConnectumTransport.md | 28 +++ .../shared/functions/estimateMessageSize.md | 2 +- .../shared/functions/wrapAsyncIterable.md | 2 +- en/api/@connectum/otel/shared/index.md | 1 + .../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 +- en/api/@connectum/test-fixtures/index.md | 8 + .../index/functions/assertConnectError.md | 62 +++++ .../index/functions/createFakeMethod.md | 51 ++++ .../index/functions/createFakeService.md | 38 +++ .../index/functions/createMockDescField.md | 42 ++++ .../index/functions/createMockDescMessage.md | 50 ++++ .../index/functions/createMockDescMethod.md | 48 ++++ .../index/functions/createMockFn.md | 39 +++ .../index/functions/createMockNext.md | 37 +++ .../index/functions/createMockNextError.md | 44 ++++ .../index/functions/createMockNextSlow.md | 41 ++++ .../index/functions/createMockRequest.md | 39 +++ .../index/functions/createMockStream.md | 55 +++++ .../@connectum/test-fixtures/index/index.md | 76 ++++++ .../index/interfaces/MockCall.md | 23 ++ .../test-fixtures/index/interfaces/MockFn.md | 61 +++++ .../@connectum/test-fixtures/types/index.md | 16 ++ .../types/interfaces/FakeMethodOptions.md | 27 +++ .../types/interfaces/FakeServiceOptions.md | 27 +++ .../types/interfaces/MockDescFieldOptions.md | 37 +++ .../interfaces/MockDescMessageOptions.md | 39 +++ .../types/interfaces/MockDescMethodOptions.md | 47 ++++ .../types/interfaces/MockNextOptions.md | 27 +++ .../types/interfaces/MockRequestOptions.md | 67 ++++++ .../types/interfaces/MockStreamOptions.md | 17 ++ .../index/classes/InMemoryMetricCollector.md | 81 +++++++ .../index/classes/InMemorySpanCollector.md | 80 +++++++ .../index/functions/assertConnectError.md | 2 +- .../index/functions/createFakeMethod.md | 4 +- .../index/functions/createFakeService.md | 4 +- .../index/functions/createLocalClient.md | 46 ++++ .../index/functions/createMockDescField.md | 4 +- .../index/functions/createMockDescMessage.md | 4 +- .../index/functions/createMockDescMethod.md | 4 +- .../testing/index/functions/createMockFn.md | 2 +- .../testing/index/functions/createMockNext.md | 4 +- .../index/functions/createMockNextError.md | 2 +- .../index/functions/createMockNextSlow.md | 4 +- .../index/functions/createMockRequest.md | 4 +- .../index/functions/createMockStream.md | 4 +- .../index/functions/createTestServer.md | 2 +- .../testing/index/functions/withTestServer.md | 2 +- en/api/@connectum/testing/index/index.md | 79 +++--- .../index/interfaces/FakeMethodOptions.md | 27 +++ .../index/interfaces/FakeServiceOptions.md | 27 +++ .../testing/index/interfaces/MockCall.md | 4 +- .../index/interfaces/MockDescFieldOptions.md | 37 +++ .../interfaces/MockDescMessageOptions.md | 39 +++ .../index/interfaces/MockDescMethodOptions.md | 47 ++++ .../testing/index/interfaces/MockFn.md | 6 +- .../index/interfaces/MockNextOptions.md | 27 +++ .../index/interfaces/MockRequestOptions.md | 67 ++++++ .../index/interfaces/MockStreamOptions.md | 17 ++ .../index/interfaces/NormalizedMetric.md | 55 +++++ .../index/interfaces/NormalizedSpan.md | 87 +++++++ .../variables/TRANSPORT_METRIC_ATTRIBUTE.md | 9 + .../variables/TRANSPORT_SPAN_ATTRIBUTE.md | 9 + en/api/@connectum/testing/types/index.md | 59 ++++- .../interfaces/CreateTestServerOptions.md | 10 +- .../types/interfaces/FakeMethodOptions.md | 27 --- .../types/interfaces/FakeServiceOptions.md | 27 --- .../types/interfaces/MockDescFieldOptions.md | 37 --- .../interfaces/MockDescMessageOptions.md | 39 --- .../types/interfaces/MockDescMethodOptions.md | 47 ---- .../types/interfaces/MockNextOptions.md | 27 --- .../types/interfaces/MockRequestOptions.md | 67 ------ .../types/interfaces/MockStreamOptions.md | 17 -- .../testing/types/interfaces/TestServer.md | 10 +- en/api/index.md | 1 + en/api/typedoc-sidebar.json | 2 +- en/contributing/parity-coverage.md | 80 +++++++ en/contributing/parity-invariant.md | 85 +++++++ en/guide/production/architecture.md | 15 ++ en/guide/production/in-process-transport.md | 224 ++++++++++++++++++ en/packages/core.md | 35 +++ en/packages/otel.md | 71 ++++++ 309 files changed, 3197 insertions(+), 950 deletions(-) create mode 100644 en/api/@connectum/core/functions/createLocalTransport.md create mode 100644 en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md create mode 100644 en/api/@connectum/core/types/interfaces/ServerClientOptions.md create mode 100644 en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md create mode 100644 en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md create mode 100644 en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md create mode 100644 en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md create mode 100644 en/api/@connectum/otel/shared/functions/detectConnectumTransport.md create mode 100644 en/api/@connectum/test-fixtures/index.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/assertConnectError.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createFakeService.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockDescField.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockFn.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockNext.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockNextError.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockRequest.md create mode 100644 en/api/@connectum/test-fixtures/index/functions/createMockStream.md create mode 100644 en/api/@connectum/test-fixtures/index/index.md create mode 100644 en/api/@connectum/test-fixtures/index/interfaces/MockCall.md create mode 100644 en/api/@connectum/test-fixtures/index/interfaces/MockFn.md create mode 100644 en/api/@connectum/test-fixtures/types/index.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md create mode 100644 en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md create mode 100644 en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md create mode 100644 en/api/@connectum/testing/index/classes/InMemorySpanCollector.md create mode 100644 en/api/@connectum/testing/index/functions/createLocalClient.md create mode 100644 en/api/@connectum/testing/index/interfaces/FakeMethodOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/FakeServiceOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/MockDescFieldOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/MockDescMessageOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/MockDescMethodOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/MockNextOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/MockRequestOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/MockStreamOptions.md create mode 100644 en/api/@connectum/testing/index/interfaces/NormalizedMetric.md create mode 100644 en/api/@connectum/testing/index/interfaces/NormalizedSpan.md create mode 100644 en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md create mode 100644 en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md delete mode 100644 en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/MockNextOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/MockRequestOptions.md delete mode 100644 en/api/@connectum/testing/types/interfaces/MockStreamOptions.md create mode 100644 en/contributing/parity-coverage.md create mode 100644 en/contributing/parity-invariant.md create mode 100644 en/guide/production/in-process-transport.md diff --git a/en/api/@connectum/auth/classes/AuthzDeniedError.md b/en/api/@connectum/auth/classes/AuthzDeniedError.md index 2708e77..c5f7523 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L26) +Defined in: [packages/auth/src/errors.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L39) +Defined in: [packages/auth/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L29) +Defined in: [packages/auth/src/errors.ts:29](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L27) +Defined in: [packages/auth/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L28) +Defined in: [packages/auth/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L31) +Defined in: [packages/auth/src/errors.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 3072ddd..279f2a1 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/cache.ts#L13) +Defined in: [packages/auth/src/cache.ts:13](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/cache.ts#L18) +Defined in: [packages/auth/src/cache.ts:18](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/cache.ts#L63) +Defined in: [packages/auth/src/cache.ts:63](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/cache.ts#L59) +Defined in: [packages/auth/src/cache.ts:59](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/cache.ts#L26) +Defined in: [packages/auth/src/cache.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/cache.ts#L41) +Defined in: [packages/auth/src/cache.ts:41](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 bbab340..141134a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/auth-interceptor.ts#L81) +Defined in: [packages/auth/src/auth-interceptor.ts:81](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 60c59c0..f16b56d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/authz-interceptor.ts#L85) +Defined in: [packages/auth/src/authz-interceptor.ts:85](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 948e2cd..ba4ea36 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 67a365f..c058265 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 1980dff..54af01e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/gateway-auth-interceptor.ts#L92) Create a gateway authentication interceptor. diff --git a/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md b/en/api/@connectum/auth/functions/createJwtAuthInterceptor.md index 1f276fc..a7cbf8d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 df6a757..c03cd65 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/proto-authz-interceptor.ts#L125) +Defined in: [packages/auth/src/proto/proto-authz-interceptor.ts:125](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/proto-authz-interceptor.ts#L125) Create a proto-based authorization interceptor. diff --git a/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md b/en/api/@connectum/auth/functions/createSessionAuthInterceptor.md index 89efe8f..ddaa435 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 36d7b3f..508e65e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/context.ts#L111) +Defined in: [packages/auth/src/context.ts:111](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/context.ts#L111) Get the current auth context. diff --git a/en/api/@connectum/auth/functions/getPublicMethods.md b/en/api/@connectum/auth/functions/getPublicMethods.md index 0f8b80d..1c62a51 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L165) +Defined in: [packages/auth/src/proto/reader.ts:165](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/reader.ts#L165) 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 ff903b1..f3d592c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/method-match.ts#L23) +Defined in: [packages/auth/src/method-match.ts:23](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/parseAuthHeaders.md b/en/api/@connectum/auth/functions/parseAuthHeaders.md index 3f0608c..780bb2e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/headers.ts#L92) +Defined in: [packages/auth/src/headers.ts:92](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 5b235b3..155db54 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/context.ts#L124) +Defined in: [packages/auth/src/context.ts:124](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 fe32728..07f300d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L65) +Defined in: [packages/auth/src/proto/reader.ts:65](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/reader.ts#L65) Resolve the effective authorization configuration for an RPC method. diff --git a/en/api/@connectum/auth/functions/setAuthHeaders.md b/en/api/@connectum/auth/functions/setAuthHeaders.md index 50066a1..ef6f1c9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/headers.ts#L36) +Defined in: [packages/auth/src/headers.ts:36](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/headers.ts#L36) Serialize AuthContext to request headers. diff --git a/en/api/@connectum/auth/interfaces/AuthContext.md b/en/api/@connectum/auth/interfaces/AuthContext.md index 79b0cf3..718608f 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L22) +Defined in: [packages/auth/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L32) +Defined in: [packages/auth/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L36) +Defined in: [packages/auth/src/types.ts:36](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L26) +Defined in: [packages/auth/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L28) +Defined in: [packages/auth/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L30) +Defined in: [packages/auth/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L24) +Defined in: [packages/auth/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L34) +Defined in: [packages/auth/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 a3263bc..e007595 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L115) +Defined in: [packages/auth/src/types.ts:115](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L151) +Defined in: [packages/auth/src/types.ts:151](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L123) +Defined in: [packages/auth/src/types.ts:123](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L158) +Defined in: [packages/auth/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L145) +Defined in: [packages/auth/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L139) +Defined in: [packages/auth/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L132) +Defined in: [packages/auth/src/types.ts:132](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 efd5169..0046e7d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L14) +Defined in: [packages/auth/src/errors.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L16) +Defined in: [packages/auth/src/errors.ts:16](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L17) +Defined in: [packages/auth/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/errors.ts#L15) +Defined in: [packages/auth/src/errors.ts:15](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 5bb643a..711e2a6 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L244) +Defined in: [packages/auth/src/types.ts:244](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L266) +Defined in: [packages/auth/src/types.ts:266](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L249) +Defined in: [packages/auth/src/types.ts:249](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L255) +Defined in: [packages/auth/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L272) +Defined in: [packages/auth/src/types.ts:272](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0772726..8e7045d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L81) +Defined in: [packages/auth/src/types.ts:81](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L87) +Defined in: [packages/auth/src/types.ts:87](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L85) +Defined in: [packages/auth/src/types.ts:85](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L83) +Defined in: [packages/auth/src/types.ts:83](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L94) +Defined in: [packages/auth/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 599d2f6..43e8044 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L105) +Defined in: [packages/auth/src/types.ts:105](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L109) +Defined in: [packages/auth/src/types.ts:109](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L107) +Defined in: [packages/auth/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 cc5213d..d22a6fc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L367) +Defined in: [packages/auth/src/types.ts:367](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L367) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L375) +Defined in: [packages/auth/src/types.ts:375](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L375) 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 f877388..d645f5e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L383) +Defined in: [packages/auth/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L383) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L389) +Defined in: [packages/auth/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L389) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L385) +Defined in: [packages/auth/src/types.ts:385](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L385) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L387) +Defined in: [packages/auth/src/types.ts:387](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L387) 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 0315e66..de43b1c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L301) +Defined in: [packages/auth/src/types.ts:301](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L318) +Defined in: [packages/auth/src/types.ts:318](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L303) +Defined in: [packages/auth/src/types.ts:303](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L316) +Defined in: [packages/auth/src/types.ts:316](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L314) +Defined in: [packages/auth/src/types.ts:314](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L312) +Defined in: [packages/auth/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L305) +Defined in: [packages/auth/src/types.ts:305](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 ab0db0b..4986aeb 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L280) +Defined in: [packages/auth/src/types.ts:280](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L292) +Defined in: [packages/auth/src/types.ts:292](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L284) +Defined in: [packages/auth/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L286) +Defined in: [packages/auth/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L288) +Defined in: [packages/auth/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L282) +Defined in: [packages/auth/src/types.ts:282](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L290) +Defined in: [packages/auth/src/types.ts:290](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L290) Header containing credential type diff --git a/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md b/en/api/@connectum/auth/interfaces/JwtAuthInterceptorOptions.md index e10c194..ade63ab 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L164) +Defined in: [packages/auth/src/types.ts:164](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L210) +Defined in: [packages/auth/src/types.ts:210](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L208) +Defined in: [packages/auth/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L215) +Defined in: [packages/auth/src/types.ts:215](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L206) +Defined in: [packages/auth/src/types.ts:206](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L166) +Defined in: [packages/auth/src/types.ts:166](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L228) +Defined in: [packages/auth/src/types.ts:228](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L238) +Defined in: [packages/auth/src/types.ts:238](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L204) +Defined in: [packages/auth/src/types.ts:204](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L204) Asymmetric public key for JWT signature verification. @@ -151,7 +151,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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L168) +Defined in: [packages/auth/src/types.ts:168](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L168) HMAC symmetric secret (for HS256/HS384/HS512) @@ -161,7 +161,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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L233) +Defined in: [packages/auth/src/types.ts:233](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L233) Methods to skip authentication for. diff --git a/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md b/en/api/@connectum/auth/interfaces/ProtoAuthzInterceptorOptions.md index a0a05b5..411344d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L398) +Defined in: [packages/auth/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L398) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L417) +Defined in: [packages/auth/src/types.ts:417](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L417) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L403) +Defined in: [packages/auth/src/types.ts:403](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L403) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L408) +Defined in: [packages/auth/src/types.ts:408](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L408) 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 d8bf9bf..5b70478 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L20) +Defined in: [packages/auth/src/proto/reader.ts:20](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/reader.ts#L20) Resolved authorization configuration for a single RPC method. @@ -14,7 +14,7 @@ Result of merging service-level defaults with method-level overrides. > `readonly` **policy**: `"allow"` \| `"deny"` \| `undefined` -Defined in: [packages/auth/src/proto/reader.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L24) +Defined in: [packages/auth/src/proto/reader.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/reader.ts#L24) Authorization policy: "allow", "deny", or undefined (use interceptor default). @@ -24,7 +24,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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L22) +Defined in: [packages/auth/src/proto/reader.ts:22](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/reader.ts#L22) Whether the method is public (skip authn + authz). @@ -34,6 +34,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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/proto/reader.ts#L26) +Defined in: [packages/auth/src/proto/reader.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/proto/reader.ts#L26) 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 02e142d..f25d4f0 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L326) +Defined in: [packages/auth/src/types.ts:326](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L326) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L349) +Defined in: [packages/auth/src/types.ts:349](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L349) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L347) +Defined in: [packages/auth/src/types.ts:347](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L347) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L342) +Defined in: [packages/auth/src/types.ts:342](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L342) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L359) +Defined in: [packages/auth/src/types.ts:359](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L359) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L353) +Defined in: [packages/auth/src/types.ts:353](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L353) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L351) +Defined in: [packages/auth/src/types.ts:351](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L351) 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L335) +Defined in: [packages/auth/src/types.ts:335](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L335) Verify session token and return raw session data. Must throw on invalid/expired sessions. diff --git a/en/api/@connectum/auth/testing/functions/createMockAuthContext.md b/en/api/@connectum/auth/testing/functions/createMockAuthContext.md index 52947fe..2d38be3 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d572f20..a73079b 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/withAuthContext.md b/en/api/@connectum/auth/testing/functions/withAuthContext.md index f1469ed..00f4658 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/testing/with-context.ts#L31) Run a function with a pre-set AuthContext. 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 ff325fa..f48e5dd 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9cbfdf0..7c277f4 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L67) +Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 da29647..d45ff79 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L14) +Defined in: [packages/auth/src/types.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/auth/src/types.ts#L14) Interceptor factory function type diff --git a/en/api/@connectum/auth/variables/AUTH_HEADERS.md b/en/api/@connectum/auth/variables/AUTH_HEADERS.md index 4494a1a..2132e05 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L49) +Defined in: [packages/auth/src/types.ts:49](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 6106efc..050f34f 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/types.ts#L67) +Defined in: [packages/auth/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 a51fa07..b1fb49a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/auth/src/context.ts#L87) +Defined in: [packages/auth/src/context.ts:87](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9539fc1..2044fc1 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L41) +Defined in: [commands/proto-sync.ts:41](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9072c2e..4d7c97d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L25) +Defined in: [commands/proto-sync.ts:25](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L33) +Defined in: [commands/proto-sync.ts:33](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L27) +Defined in: [commands/proto-sync.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L29) +Defined in: [commands/proto-sync.ts:29](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L31) +Defined in: [commands/proto-sync.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 3f42577..5b2c7d9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/commands/proto-sync.ts#L113) +Defined in: [commands/proto-sync.ts:113](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 597a321..dfc1f5d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L72) +Defined in: [utils/reflection.ts:72](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 193acdb..89bd9ae 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L42) +Defined in: [utils/reflection.ts:42](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 92f3f68..c72d17c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L19) +Defined in: [utils/reflection.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L25) +Defined in: [utils/reflection.ts:25](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L23) +Defined in: [utils/reflection.ts:23](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/cli/src/utils/reflection.ts#L21) +Defined in: [utils/reflection.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/cli/src/utils/reflection.ts#L21) List of fully-qualified service names diff --git a/en/api/@connectum/core/functions/createLocalTransport.md b/en/api/@connectum/core/functions/createLocalTransport.md new file mode 100644 index 0000000..ff1f3fd --- /dev/null +++ b/en/api/@connectum/core/functions/createLocalTransport.md @@ -0,0 +1,43 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / createLocalTransport + +# Function: createLocalTransport() + +> **createLocalTransport**(`server`, `options?`): `Transport` + +Defined in: packages/core/src/localTransport.ts:104 + +Create an in-process ConnectRPC `Transport` over the services already +registered on the given Connectum `Server`. + +The transport is safe to use before `server.start()` — it never opens a +TCP/UDP port or HTTP/2 session. Server-side interceptors configured via +`createServer({ interceptors })` are applied inside the handler chain; +`options.interceptors` are applied on the client side of the call. + +Headers are propagated via `Headers` objects through the in-memory pipe; +the wrapped `createRouterTransport` already clones headers at the call +boundary, providing mutation isolation between client and server. + +The synthetic origin observed by interceptors reading `req.url` is +`https://in-memory//` (set by the underlying ConnectRPC +router transport — see `@connectrpc/connect`'s `router-transport.ts`). + +## Parameters + +### server + +[`Server`](../types/interfaces/Server.md) + +A server created via `createServer({...})`. + +### options? + +[`CreateLocalTransportOptions`](../interfaces/CreateLocalTransportOptions.md) + +Optional client-side interceptors. + +## Returns + +`Transport` + +A ConnectRPC `Transport` suitable for `createClient(service, transport)`. diff --git a/en/api/@connectum/core/functions/createServer.md b/en/api/@connectum/core/functions/createServer.md index 9016181..3695bf3 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:297](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/Server.ts#L297) +Defined in: [packages/core/src/Server.ts:430](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/Server.ts#L430) Create a new server instance diff --git a/en/api/@connectum/core/functions/getTLSPath.md b/en/api/@connectum/core/functions/getTLSPath.md index 40b6b4b..8606228 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/TLSConfig.ts#L20) +Defined in: [packages/core/src/TLSConfig.ts:20](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d9b1481..11acea3 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/errors.ts#L28) +Defined in: [packages/core/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/errors.ts#L28) Type guard for SanitizableError. diff --git a/en/api/@connectum/core/functions/parseEnvConfig.md b/en/api/@connectum/core/functions/parseEnvConfig.md index 8d7db5c..fc91ef9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L145) +Defined in: [packages/core/src/config/envSchema.ts:145](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/config/envSchema.ts#L145) Parse and validate environment configuration diff --git a/en/api/@connectum/core/functions/readTLSCertificates.md b/en/api/@connectum/core/functions/readTLSCertificates.md index 0aa994a..24d05bc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/TLSConfig.ts#L36) +Defined in: [packages/core/src/TLSConfig.ts:36](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/TLSConfig.ts#L36) Read TLS certificates from configuration diff --git a/en/api/@connectum/core/functions/safeParseEnvConfig.md b/en/api/@connectum/core/functions/safeParseEnvConfig.md index aa57f09..329ed0e 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"` \| `"debug"` \| `"info"` \| `"warn"`; `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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L162) +Defined in: [packages/core/src/config/envSchema.ts:162](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/config/envSchema.ts#L162) Safely parse environment configuration (returns result object) diff --git a/en/api/@connectum/core/index.md b/en/api/@connectum/core/index.md index 9254e0e..39f751f 100644 --- a/en/api/@connectum/core/index.md +++ b/en/api/@connectum/core/index.md @@ -9,6 +9,7 @@ ## Interfaces +- [CreateLocalTransportOptions](interfaces/CreateLocalTransportOptions.md) - [SanitizableError](interfaces/SanitizableError.md) ## Type Aliases @@ -27,6 +28,7 @@ ## Functions +- [createLocalTransport](functions/createLocalTransport.md) - [createServer](functions/createServer.md) - [getTLSPath](functions/getTLSPath.md) - [isSanitizableError](functions/isSanitizableError.md) @@ -90,6 +92,12 @@ Re-exports [Server](types/interfaces/Server.md) *** +### ServerClientOptions + +Re-exports [ServerClientOptions](types/interfaces/ServerClientOptions.md) + +*** + ### ServerState Re-exports [ServerState](types/variables/ServerState.md) diff --git a/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md b/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md new file mode 100644 index 0000000..6489c4c --- /dev/null +++ b/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md @@ -0,0 +1,20 @@ +[Connectum API Reference](../../../index.md) / [@connectum/core](../index.md) / CreateLocalTransportOptions + +# Interface: CreateLocalTransportOptions + +Defined in: packages/core/src/localTransport.ts:44 + +Options for [createLocalTransport](../functions/createLocalTransport.md). + +## Properties + +### interceptors? + +> `optional` **interceptors?**: `Interceptor`[] + +Defined in: packages/core/src/localTransport.ts:51 + +Client-side interceptors applied to outbound calls before they reach +the registered handlers. Server-side interceptors configured on the +`Server` instance still run inside the handler chain — these are +additive and run on the client side of the in-memory pipe. diff --git a/en/api/@connectum/core/interfaces/SanitizableError.md b/en/api/@connectum/core/interfaces/SanitizableError.md index cb56151..5d02d23 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/errors.ts#L17) +Defined in: [packages/core/src/errors.ts:17](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/errors.ts#L18) +Defined in: [packages/core/src/errors.ts:18](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/errors.ts#L19) +Defined in: [packages/core/src/errors.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/errors.ts#L19) diff --git a/en/api/@connectum/core/type-aliases/ConnectumEnv.md b/en/api/@connectum/core/type-aliases/ConnectumEnv.md index 7617687..1aae629 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L133) +Defined in: [packages/core/src/config/envSchema.ts:133](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/config/envSchema.ts#L133) Connectum environment configuration type diff --git a/en/api/@connectum/core/types/index.md b/en/api/@connectum/core/types/index.md index cfbf462..88c3ff2 100644 --- a/en/api/@connectum/core/types/index.md +++ b/en/api/@connectum/core/types/index.md @@ -11,6 +11,7 @@ Public API types for Server - [ProtocolContext](interfaces/ProtocolContext.md) - [ProtocolRegistration](interfaces/ProtocolRegistration.md) - [Server](interfaces/Server.md) +- [ServerClientOptions](interfaces/ServerClientOptions.md) - [ShutdownOptions](interfaces/ShutdownOptions.md) - [TLSOptions](interfaces/TLSOptions.md) diff --git a/en/api/@connectum/core/types/interfaces/CreateServerOptions.md b/en/api/@connectum/core/types/interfaces/CreateServerOptions.md index 4b1e3ba..20d5ad7 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:214](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L214) +Defined in: [packages/core/src/types.ts:214](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L214) Server configuration options for createServer() @@ -12,7 +12,7 @@ Server configuration options for createServer() > `optional` **allowHTTP1?**: `boolean` -Defined in: [packages/core/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L298) +Defined in: [packages/core/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L298) Allow HTTP/1.1 connections. @@ -32,7 +32,7 @@ true > `optional` **eventBus?**: [`EventBusLike`](EventBusLike.md) -Defined in: [packages/core/src/types.ts:287](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L287) +Defined in: [packages/core/src/types.ts:287](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L287) Event bus instance for pub/sub messaging. @@ -62,7 +62,7 @@ const server = createServer({ > `optional` **handshakeTimeout?**: `number` -Defined in: [packages/core/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L304) +Defined in: [packages/core/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L304) Handshake timeout in milliseconds @@ -78,7 +78,7 @@ Handshake timeout in milliseconds > `optional` **host?**: `string` -Defined in: [packages/core/src/types.ts:230](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L230) +Defined in: [packages/core/src/types.ts:230](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L230) Server host to bind @@ -94,7 +94,7 @@ Server host to bind > `optional` **http2Options?**: `SecureServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`, *typeof* `Http2ServerRequest`, *typeof* `Http2ServerResponse`\> -Defined in: [packages/core/src/types.ts:309](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L309) +Defined in: [packages/core/src/types.ts:309](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L309) Additional HTTP/2 server options @@ -104,7 +104,7 @@ Additional HTTP/2 server options > `optional` **interceptors?**: `Interceptor`[] -Defined in: [packages/core/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L263) +Defined in: [packages/core/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L263) ConnectRPC interceptors. When omitted or `[]`, no interceptors are applied. @@ -116,7 +116,7 @@ Use `createDefaultInterceptors()` from `@connectum/interceptors` to get the defa > `optional` **port?**: `number` -Defined in: [packages/core/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L224) +Defined in: [packages/core/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L224) Server port @@ -132,7 +132,7 @@ Server port > `optional` **protocols?**: [`ProtocolRegistration`](ProtocolRegistration.md)[] -Defined in: [packages/core/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L251) +Defined in: [packages/core/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L251) Protocol registrations (healthcheck, reflection, custom) @@ -154,7 +154,7 @@ const server = createServer({ > **services**: [`ServiceRoute`](../type-aliases/ServiceRoute.md)[] -Defined in: [packages/core/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L218) +Defined in: [packages/core/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L218) Service routes to register @@ -164,7 +164,7 @@ Service routes to register > `optional` **shutdown?**: [`ShutdownOptions`](ShutdownOptions.md) -Defined in: [packages/core/src/types.ts:256](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L256) +Defined in: [packages/core/src/types.ts:256](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L256) Graceful shutdown configuration @@ -174,6 +174,6 @@ Graceful shutdown configuration > `optional` **tls?**: [`TLSOptions`](TLSOptions.md) -Defined in: [packages/core/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L235) +Defined in: [packages/core/src/types.ts:235](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L235) TLS configuration diff --git a/en/api/@connectum/core/types/interfaces/EventBusLike.md b/en/api/@connectum/core/types/interfaces/EventBusLike.md index 0b34c04..17cb6af 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:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L126) +Defined in: [packages/core/src/types.ts:126](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L126) 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:133](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L133) +Defined in: [packages/core/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L133) 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:135](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L135) +Defined in: [packages/core/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L135) 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 3576aad..de9c45a 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:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L51) +Defined in: [packages/core/src/types.ts:51](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L51) 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:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L53) +Defined in: [packages/core/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L53) 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 83efb44..0a2e4be 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:84](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L84) +Defined in: [packages/core/src/types.ts:84](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L84) Protocol registration interface @@ -31,7 +31,7 @@ const server = createServer({ > `optional` **httpHandler?**: [`HttpHandler`](../type-aliases/HttpHandler.md) -Defined in: [packages/core/src/types.ts:92](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L92) +Defined in: [packages/core/src/types.ts:92](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L92) 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:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L86) +Defined in: [packages/core/src/types.ts:86](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L86) 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:89](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L89) +Defined in: [packages/core/src/types.ts:89](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L89) 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 5dad68d..7200dc8 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:333](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L333) +Defined in: [packages/core/src/types.ts:333](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L333) Server interface with explicit lifecycle control @@ -35,7 +35,7 @@ await server.stop(); > `readonly` **address**: `AddressInfo` \| `null` -Defined in: [packages/core/src/types.ts:361](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L361) +Defined in: [packages/core/src/types.ts:361](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L361) 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:501](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L501) +Defined in: [packages/core/src/types.ts:501](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L501) 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:489](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L489) +Defined in: [packages/core/src/types.ts:489](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L489) Registered interceptors @@ -69,7 +69,7 @@ Registered interceptors > `readonly` **isRunning**: `boolean` -Defined in: [packages/core/src/types.ts:366](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L366) +Defined in: [packages/core/src/types.ts:366](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L366) 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:494](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L494) +Defined in: [packages/core/src/types.ts:494](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L494) Registered protocols @@ -89,7 +89,7 @@ Registered protocols > `readonly` **routes**: readonly [`ServiceRoute`](../type-aliases/ServiceRoute.md)[] -Defined in: [packages/core/src/types.ts:484](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L484) +Defined in: [packages/core/src/types.ts:484](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L484) Registered service routes @@ -99,7 +99,7 @@ Registered service routes > `readonly` **shutdownSignal**: `AbortSignal` -Defined in: [packages/core/src/types.ts:468](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L468) +Defined in: [packages/core/src/types.ts:468](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L468) 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:371](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L371) +Defined in: [packages/core/src/types.ts:371](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L371) 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:479](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L479) +Defined in: [packages/core/src/types.ts:479](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L479) Underlying transport server @@ -193,7 +193,7 @@ v13.4.0, v12.16.0 > **addInterceptor**(`interceptor`): `void` -Defined in: [packages/core/src/types.ts:420](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L420) +Defined in: [packages/core/src/types.ts:420](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L420) Add an interceptor at runtime @@ -255,7 +255,7 @@ v0.1.26 > **addProtocol**(`protocol`): `void` -Defined in: [packages/core/src/types.ts:427](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L427) +Defined in: [packages/core/src/types.ts:427](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L427) 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:413](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L413) +Defined in: [packages/core/src/types.ts:413](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L413) Add a service route at runtime @@ -299,6 +299,52 @@ Error if server is already running *** +### client() + +> **client**\<`T`\>(`service`, `options?`): `Client`\<`T`\> + +Defined in: [packages/core/src/types.ts:561](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L561) + +Unified client factory: auto-routes to the in-process transport if the +service is registered on this `Server`, otherwise uses `options.fallback` +transport (e.g. a `createGrpcTransport({ baseUrl })` to a remote peer). +Without `fallback`, an unregistered service raises `ConnectError` +(`Code.Unimplemented`) at client construction time — fail-fast. + +Enables polyglot deployments where the same call site (`server.client(S)`) +routes locally in a modular monolith and remotely when the service is +split into a separate process — without code changes. + +#### Type Parameters + +##### T + +`T` *extends* `DescService` + +#### Parameters + +##### service + +`T` + +##### options? + +[`ServerClientOptions`](ServerClientOptions.md) + +#### Returns + +`Client`\<`T`\> + +#### Example + +```typescript +// Same call works whether GreeterService is co-located or remote: +const client = server.client(GreeterService, { fallback: remoteTransport }); +await client.sayHello({ name: 'world' }); +``` + +*** + ### emit() > **emit**\<`E`\>(`eventName`, ...`args`): `boolean` @@ -435,6 +481,39 @@ v1.0.0 *** +### hasService() + +> **hasService**(`desc`): `boolean` + +Defined in: [packages/core/src/types.ts:541](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L541) + +Synchronous registry lookup: returns whether the given proto service +descriptor is served locally by this `Server`. Triggers route +materialization on first call. + +Source of truth is the same `ConnectRouter.service(desc, impl)` chain +used to build the HTTP handler — no separate registration step. + +#### Parameters + +##### desc + +`DescService` + +#### Returns + +`boolean` + +#### Example + +```typescript +if (server.hasService(GreeterService)) { + // routed in-process +} +``` + +*** + ### listenerCount() > **listenerCount**\<`E`\>(`eventName`, `listener?`): `number` @@ -521,13 +600,54 @@ v0.1.26 *** +### localClient() + +> **localClient**\<`T`\>(`service`): `Client`\<`T`\> + +Defined in: [packages/core/src/types.ts:524](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L524) + +Create a fully-typed ConnectRPC client that dispatches calls directly +to handlers registered on this server, without opening any TCP socket. + +Safe to call before `server.start()` — the routes are materialized +lazily on first access. Once materialized, `addService` / `addInterceptor` +/ `addProtocol` will throw. + +#### Type Parameters + +##### T + +`T` *extends* `DescService` + +#### Parameters + +##### service + +`T` + +#### Returns + +`Client`\<`T`\> + +#### Example + +```typescript +import { GreeterService } from './gen/greeter_pb.js'; + +const server = createServer({ services: [routes] }); +const client = server.localClient(GreeterService); +const response = await client.sayHello({ name: 'world' }); +``` + +*** + ### off() #### Call Signature > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L398) +Defined in: [packages/core/src/types.ts:398](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L398) Remove listener for lifecycle events @@ -553,7 +673,7 @@ Remove listener for lifecycle events > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:399](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L399) +Defined in: [packages/core/src/types.ts:399](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L399) Alias for `emitter.removeListener()`. @@ -583,7 +703,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:400](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L400) +Defined in: [packages/core/src/types.ts:400](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L400) Alias for `emitter.removeListener()`. @@ -613,7 +733,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:401](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L401) +Defined in: [packages/core/src/types.ts:401](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L401) Alias for `emitter.removeListener()`. @@ -643,7 +763,7 @@ v10.0.0 > **off**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:402](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L402) +Defined in: [packages/core/src/types.ts:402](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L402) Alias for `emitter.removeListener()`. @@ -677,7 +797,7 @@ v10.0.0 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:380](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L380) +Defined in: [packages/core/src/types.ts:380](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L380) Register listener for lifecycle events @@ -703,7 +823,7 @@ Register listener for lifecycle events > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:381](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L381) +Defined in: [packages/core/src/types.ts:381](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L381) 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 @@ -762,7 +882,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:382](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L382) +Defined in: [packages/core/src/types.ts:382](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L382) 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 @@ -821,7 +941,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L383) +Defined in: [packages/core/src/types.ts:383](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L383) 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 @@ -880,7 +1000,7 @@ v0.1.101 > **on**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:384](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L384) +Defined in: [packages/core/src/types.ts:384](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L384) 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 @@ -943,7 +1063,7 @@ v0.1.101 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L389) +Defined in: [packages/core/src/types.ts:389](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L389) Register one-time listener for lifecycle events @@ -969,7 +1089,7 @@ Register one-time listener for lifecycle events > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:390](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L390) +Defined in: [packages/core/src/types.ts:390](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L390) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1025,7 +1145,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:391](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L391) +Defined in: [packages/core/src/types.ts:391](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L391) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1081,7 +1201,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:392](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L392) +Defined in: [packages/core/src/types.ts:392](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L392) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1137,7 +1257,7 @@ v0.3.0 > **once**(`event`, `listener`): `this` -Defined in: [packages/core/src/types.ts:393](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L393) +Defined in: [packages/core/src/types.ts:393](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L393) Adds a **one-time** `listener` function for the event named `eventName`. The next time `eventName` is triggered, this listener is removed and then invoked. @@ -1197,7 +1317,7 @@ v0.3.0 > **onShutdown**(`handler`): `void` -Defined in: [packages/core/src/types.ts:439](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L439) +Defined in: [packages/core/src/types.ts:439](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L439) Register an anonymous shutdown hook @@ -1221,7 +1341,7 @@ Error if server is already stopped > **onShutdown**(`name`, `handler`): `void` -Defined in: [packages/core/src/types.ts:448](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L448) +Defined in: [packages/core/src/types.ts:448](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L448) Register a named shutdown hook @@ -1251,7 +1371,7 @@ Error if server is already stopped > **onShutdown**(`name`, `dependencies`, `handler`): `void` -Defined in: [packages/core/src/types.ts:460](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L460) +Defined in: [packages/core/src/types.ts:460](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L460) Register a named shutdown hook with dependencies @@ -1651,7 +1771,7 @@ v0.3.5 > **start**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L343) +Defined in: [packages/core/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L343) Start the server @@ -1669,7 +1789,7 @@ Error if server is not in CREATED state > **stop**(): `Promise`\<`void`\> -Defined in: [packages/core/src/types.ts:350](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L350) +Defined in: [packages/core/src/types.ts:350](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L350) Stop the server gracefully diff --git a/en/api/@connectum/core/types/interfaces/ServerClientOptions.md b/en/api/@connectum/core/types/interfaces/ServerClientOptions.md new file mode 100644 index 0000000..3aa65aa --- /dev/null +++ b/en/api/@connectum/core/types/interfaces/ServerClientOptions.md @@ -0,0 +1,21 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/core](../../index.md) / [types](../index.md) / ServerClientOptions + +# Interface: ServerClientOptions + +Defined in: [packages/core/src/types.ts:567](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L567) + +Options for [Server.client](Server.md#client). + +## Properties + +### fallback? + +> `optional` **fallback?**: `Transport` + +Defined in: [packages/core/src/types.ts:575](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L575) + +Transport used when the requested service is NOT registered on this +`Server`. Typically a remote HTTP/gRPC transport. + +If omitted and the service is not local, `Server.client()` throws +`ConnectError` with `Code.Unimplemented`. diff --git a/en/api/@connectum/core/types/interfaces/ShutdownOptions.md b/en/api/@connectum/core/types/interfaces/ShutdownOptions.md index 8d38c6a..be98a76 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:183](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L183) +Defined in: [packages/core/src/types.ts:183](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L183) Graceful shutdown options @@ -12,7 +12,7 @@ Graceful shutdown options > `optional` **autoShutdown?**: `boolean` -Defined in: [packages/core/src/types.ts:200](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L200) +Defined in: [packages/core/src/types.ts:200](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L200) Enable automatic graceful shutdown on signals @@ -28,7 +28,7 @@ false > `optional` **forceCloseOnTimeout?**: `boolean` -Defined in: [packages/core/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L208) +Defined in: [packages/core/src/types.ts:208](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L208) 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:194](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L194) +Defined in: [packages/core/src/types.ts:194](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L194) 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:188](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L188) +Defined in: [packages/core/src/types.ts:188](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L188) 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 613565f..65b30e2 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:98](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L98) +Defined in: [packages/core/src/types.ts:98](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L98) TLS configuration options @@ -12,7 +12,7 @@ TLS configuration options > `optional` **certPath?**: `string` -Defined in: [packages/core/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L107) +Defined in: [packages/core/src/types.ts:107](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L107) Path to TLS certificate file @@ -22,7 +22,7 @@ Path to TLS certificate file > `optional` **dirPath?**: `string` -Defined in: [packages/core/src/types.ts:113](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L113) +Defined in: [packages/core/src/types.ts:113](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L113) 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:102](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L102) +Defined in: [packages/core/src/types.ts:102](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L102) 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 63f157c..a38aec4 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:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L61) +Defined in: [packages/core/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L61) 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 06a8422..9d8ce21 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:165](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L165) +Defined in: [packages/core/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L165) 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 c8ed697..d732868 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:19](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L19) +Defined in: [packages/core/src/types.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L19) 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 e2a1ffd..5f62572 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:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L22) +Defined in: [packages/core/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L22) 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 71d9631..9364f36 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:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L147) +Defined in: [packages/core/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L147) Server state constants diff --git a/en/api/@connectum/core/types/type-aliases/ServiceRoute.md b/en/api/@connectum/core/types/type-aliases/ServiceRoute.md index ec5aabf..b586f99 100644 --- a/en/api/@connectum/core/types/type-aliases/ServiceRoute.md +++ b/en/api/@connectum/core/types/type-aliases/ServiceRoute.md @@ -4,7 +4,7 @@ > **ServiceRoute** = (`router`) => `void` -Defined in: [packages/core/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L32) +Defined in: [packages/core/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L32) Service route function diff --git a/en/api/@connectum/core/types/type-aliases/ShutdownHook.md b/en/api/@connectum/core/types/type-aliases/ShutdownHook.md index 3ab0246..582a26d 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:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L39) +Defined in: [packages/core/src/types.ts:39](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L39) 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 0b18efa..a008ddf 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:25](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L25) +Defined in: [packages/core/src/types.ts:25](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L25) 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 fdc874e..584179f 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:165](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L165) +Defined in: [packages/core/src/types.ts:165](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L165) Lifecycle event names diff --git a/en/api/@connectum/core/types/variables/ServerState.md b/en/api/@connectum/core/types/variables/ServerState.md index b41b0d4..23a6c96 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:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/types.ts#L147) +Defined in: [packages/core/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/types.ts#L147) Server state constants diff --git a/en/api/@connectum/core/variables/BooleanFromStringSchema.md b/en/api/@connectum/core/variables/BooleanFromStringSchema.md index b60fe9f..b5f1e50 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L35) +Defined in: [packages/core/src/config/envSchema.ts:35](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 35a9189..dc4b04c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L53) +Defined in: [packages/core/src/config/envSchema.ts:53](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/config/envSchema.ts#L53) Connectum environment configuration schema diff --git a/en/api/@connectum/core/variables/LogFormatSchema.md b/en/api/@connectum/core/variables/LogFormatSchema.md index 9565e58..4704c23 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L20) +Defined in: [packages/core/src/config/envSchema.ts:20](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 69c7b97..4e317fc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L15) +Defined in: [packages/core/src/config/envSchema.ts:15](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 3767bb9..d76d3c9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L25) +Defined in: [packages/core/src/config/envSchema.ts:25](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9166103..c639eb8 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/config/envSchema.ts#L30) +Defined in: [packages/core/src/config/envSchema.ts:30](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/config/envSchema.ts#L30) Node environment schema diff --git a/en/api/@connectum/core/variables/tlsPath.md b/en/api/@connectum/core/variables/tlsPath.md index 2c3b052..0b55f3b 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/core/src/TLSConfig.ts#L63) +Defined in: [packages/core/src/TLSConfig.ts:63](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/core/src/TLSConfig.ts#L63) Exported for backward compatibility diff --git a/en/api/@connectum/events-amqp/functions/AmqpAdapter.md b/en/api/@connectum/events-amqp/functions/AmqpAdapter.md index 7f1cbba..e62fd61 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: [AmqpAdapter.ts:77](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/AmqpAdapter.ts#L77) +Defined in: [AmqpAdapter.ts:77](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/AmqpAdapter.ts#L77) 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 41ef11c..dac3b36 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: [AmqpAdapter.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/AmqpAdapter.ts#L35) +Defined in: [AmqpAdapter.ts:35](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/AmqpAdapter.ts#L35) 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 f47f065..2cc27b5 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: [types.ts:10](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L10) +Defined in: [types.ts:10](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L50) Consumer options. @@ -22,7 +22,7 @@ Consumer options. > `readonly` `optional` **exchange?**: `string` -Defined in: [types.ts:28](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L28) +Defined in: [types.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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: [types.ts:40](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L40) +Defined in: [types.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L40) Exchange assertion options. @@ -48,7 +48,7 @@ Exchange assertion options. > `readonly` `optional` **exchangeType?**: `"topic"` \| `"direct"` \| `"fanout"` \| `"headers"` -Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L35) +Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L35) Exchange type. @@ -64,7 +64,7 @@ Exchange type. > `readonly` `optional` **publisherOptions?**: [`AmqpPublisherOptions`](AmqpPublisherOptions.md) -Defined in: [types.ts:55](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L55) +Defined in: [types.ts:55](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L55) Publisher options. @@ -74,7 +74,7 @@ Publisher options. > `readonly` `optional` **queueOptions?**: [`AmqpQueueOptions`](AmqpQueueOptions.md) -Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L45) +Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L45) Default queue assertion options. @@ -84,7 +84,7 @@ Default queue assertion options. > `readonly` `optional` **socketOptions?**: `Record`\<`string`, `unknown`\> -Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L21) Socket options passed to `amqplib.connect()`. @@ -94,7 +94,7 @@ Socket options passed to `amqplib.connect()`. > `readonly` **url**: `string` -Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L16) AMQP connection URL. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md index 14b9973..27aad7f 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: [types.ts:112](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L112) +Defined in: [types.ts:112](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L112) Consumer options. @@ -12,7 +12,7 @@ Consumer options. > `readonly` `optional` **exclusive?**: `boolean` -Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L126) +Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L126) Whether the consumer is exclusive to this connection. @@ -28,7 +28,7 @@ false > `readonly` `optional` **prefetch?**: `number` -Defined in: [types.ts:119](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L119) +Defined in: [types.ts:119](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L119) Prefetch count (QoS) — how many unacknowledged messages a consumer can have at a time. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md index e0b8489..f2eef8c 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: [types.ts:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L61) +Defined in: [types.ts:61](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L61) Exchange assertion options. @@ -12,7 +12,7 @@ Exchange assertion options. > `readonly` `optional` **autoDelete?**: `boolean` -Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L74) +Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L74) Whether the exchange is deleted when the last queue unbinds. @@ -28,7 +28,7 @@ false > `readonly` `optional` **durable?**: `boolean` -Defined in: [types.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L67) +Defined in: [types.ts:67](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L67) Whether the exchange should survive broker restarts. diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md index 6ca39d7..2dfc37e 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: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L132) +Defined in: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L132) Publisher options. @@ -12,7 +12,7 @@ Publisher options. > `readonly` `optional` **mandatory?**: `boolean` -Defined in: [types.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L145) +Defined in: [types.ts:145](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L145) Whether the message should be returned if it cannot be routed. @@ -28,7 +28,7 @@ false > `readonly` `optional` **persistent?**: `boolean` -Defined in: [types.ts:138](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L138) +Defined in: [types.ts:138](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L138) Whether messages should be persisted to disk (deliveryMode=2). diff --git a/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md b/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.md index 19d36b1..c7584e8 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: [types.ts:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L80) +Defined in: [types.ts:80](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L80) Queue assertion options. @@ -12,7 +12,7 @@ Queue assertion options. > `readonly` `optional` **deadLetterExchange?**: `string` -Defined in: [types.ts:101](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L101) +Defined in: [types.ts:101](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L101) Dead letter exchange name for rejected messages. @@ -22,7 +22,7 @@ Dead letter exchange name for rejected messages. > `readonly` `optional` **deadLetterRoutingKey?**: `string` -Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L106) +Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L106) Dead letter routing key for rejected messages. @@ -32,7 +32,7 @@ Dead letter routing key for rejected messages. > `readonly` `optional` **durable?**: `boolean` -Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L86) +Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L86) Whether the queue should survive broker restarts. @@ -48,7 +48,7 @@ true > `readonly` `optional` **maxLength?**: `number` -Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L96) Maximum number of messages in the queue. @@ -58,6 +58,6 @@ Maximum number of messages in the queue. > `readonly` `optional` **messageTtl?**: `number` -Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-amqp/src/types.ts#L91) +Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events-amqp/src/types.ts#L91) Per-message TTL in milliseconds. diff --git a/en/api/@connectum/events-kafka/functions/KafkaAdapter.md b/en/api/@connectum/events-kafka/functions/KafkaAdapter.md index 86d8b36..831823a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/KafkaAdapter.ts#L122) +Defined in: [KafkaAdapter.ts:122](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 43bc6ed..b076bb7 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/types.ts#L17) +Defined in: [types.ts:17](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/types.ts#L23) +Defined in: [types.ts:23](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-kafka/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 38cea4e..2a808f1 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/NatsAdapter.ts#L83) +Defined in: [NatsAdapter.ts:83](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 423be02..ed3ee2a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L35) +Defined in: [types.ts:35](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L24) +Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 346784d..88c069a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L41) +Defined in: [types.ts:41](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L58) +Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-nats/src/types.ts#L66) +Defined in: [types.ts:66](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 44007e0..64f34f5 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/RedisAdapter.ts#L68) +Defined in: [RedisAdapter.ts:68](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0ee5c33..de358b7 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L12) +Defined in: [types.ts:12](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L19) +Defined in: [types.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d5ab441..06e7d1c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L63) +Defined in: [types.ts:63](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events-redis/src/types.ts#L46) +Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 bb928e8..04cb200 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventRouter.ts#L17) +Defined in: [packages/events/src/EventRouter.ts:17](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventRouter.ts#L18) +Defined in: [packages/events/src/EventRouter.ts:18](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventRouter.ts#L19) +Defined in: [packages/events/src/EventRouter.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventRouter.ts#L21) +Defined in: [packages/events/src/EventRouter.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 554ca5e..8839d3e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L27) +Defined in: [packages/events/src/errors.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L30) +Defined in: [packages/events/src/errors.ts:30](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L28) +Defined in: [packages/events/src/errors.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L39) +Defined in: [packages/events/src/errors.ts:39](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0897591..3f65c07 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L56) +Defined in: [packages/events/src/errors.ts:56](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L59) +Defined in: [packages/events/src/errors.ts:59](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L57) +Defined in: [packages/events/src/errors.ts:57](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/errors.ts#L68) +Defined in: [packages/events/src/errors.ts:68](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 fe92794..efec85f 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/MemoryAdapter.ts#L23) +Defined in: [packages/events/src/MemoryAdapter.ts:23](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2ae0d44..36c059f 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/middleware.ts#L24) +Defined in: [packages/events/src/middleware.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/middleware.ts#L24) Compose an array of middleware into a single handler. diff --git a/en/api/@connectum/events/functions/createEventBus.md b/en/api/@connectum/events/functions/createEventBus.md index 2ae48ab..72ebdb2 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventBus.ts#L71) +Defined in: [packages/events/src/EventBus.ts:71](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/EventBus.ts#L71) Create an EventBus instance. diff --git a/en/api/@connectum/events/functions/createEventContext.md b/en/api/@connectum/events/functions/createEventContext.md index d94899d..2b0539e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventContext.ts#L18) +Defined in: [packages/events/src/EventContext.ts:18](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 fe73c87..d3e85c9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/EventBus.ts#L41) +Defined in: [packages/events/src/EventBus.ts:41](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/EventBus.ts#L41) 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 1494db9..1ca451a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/middleware/dlq.ts#L29) +Defined in: [packages/events/src/middleware/dlq.ts:29](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 b9b4688..d0bfa6c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/wildcard.ts#L27) +Defined in: [packages/events/src/wildcard.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 cb10294..079a36f 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/topic.ts#L22) +Defined in: [packages/events/src/topic.ts:22](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 7432a0f..967d904 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/middleware/retry.ts#L48) +Defined in: [packages/events/src/middleware/retry.ts:48](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/middleware/retry.ts#L48) Create a retry middleware with configurable options. diff --git a/en/api/@connectum/events/types/interfaces/AdapterContext.md b/en/api/@connectum/events/types/interfaces/AdapterContext.md index 1136917..7eace0a 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:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L80) +Defined in: [packages/events/src/types.ts:80](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L80) 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:90](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L90) +Defined in: [packages/events/src/types.ts:90](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L90) 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 d4d4757..6bbd832 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:269](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L269) +Defined in: [packages/events/src/types.ts:269](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L269) 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:278](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L278) +Defined in: [packages/events/src/types.ts:278](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L278) 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:271](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L271) +Defined in: [packages/events/src/types.ts:271](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L271) DLQ topic name diff --git a/en/api/@connectum/events/types/interfaces/EventAdapter.md b/en/api/@connectum/events/types/interfaces/EventAdapter.md index 820825b..63670ea 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:99](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L99) +Defined in: [packages/events/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L99) 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:101](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L101) +Defined in: [packages/events/src/types.ts:101](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L101) 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:110](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L110) +Defined in: [packages/events/src/types.ts:110](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L110) 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:113](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L113) +Defined in: [packages/events/src/types.ts:113](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L113) 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:116](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L116) +Defined in: [packages/events/src/types.ts:116](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L116) 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:119](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L119) +Defined in: [packages/events/src/types.ts:119](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L119) 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 59d612b..64d59d6 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:333](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L333) +Defined in: [packages/events/src/types.ts:333](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L333) 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:347](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L347) +Defined in: [packages/events/src/types.ts:347](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L347) Publish a typed event @@ -46,7 +46,7 @@ Publish a typed event > **start**(`options?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L343) +Defined in: [packages/events/src/types.ts:343](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L343) 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:345](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L345) +Defined in: [packages/events/src/types.ts:345](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L345) 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 2f5343b..95d9244 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:296](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L296) +Defined in: [packages/events/src/types.ts:296](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L296) 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:298](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L298) +Defined in: [packages/events/src/types.ts:298](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L298) 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:327](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L327) +Defined in: [packages/events/src/types.ts:327](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L327) 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:302](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L302) +Defined in: [packages/events/src/types.ts:302](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L302) Consumer group name @@ -46,7 +46,7 @@ Consumer group name > `optional` **handlerTimeout?**: `number` -Defined in: [packages/events/src/types.ts:319](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L319) +Defined in: [packages/events/src/types.ts:319](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L319) 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:304](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L304) +Defined in: [packages/events/src/types.ts:304](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L304) Middleware configuration @@ -69,7 +69,7 @@ Middleware configuration > `optional` **routes?**: [`EventRoute`](../type-aliases/EventRoute.md)[] -Defined in: [packages/events/src/types.ts:300](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L300) +Defined in: [packages/events/src/types.ts:300](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L300) Event routes to register @@ -79,7 +79,7 @@ Event routes to register > `optional` **signal?**: `AbortSignal` -Defined in: [packages/events/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L312) +Defined in: [packages/events/src/types.ts:312](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L312) Abort signal for graceful shutdown. diff --git a/en/api/@connectum/events/types/interfaces/EventContext.md b/en/api/@connectum/events/types/interfaces/EventContext.md index 3ddc3cb..51cdcb6 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:133](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L133) +Defined in: [packages/events/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L133) 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:143](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L143) +Defined in: [packages/events/src/types.ts:143](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L143) Delivery attempt number (1-based) @@ -26,7 +26,7 @@ Delivery attempt number (1-based) > `readonly` **eventId**: `string` -Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L137) +Defined in: [packages/events/src/types.ts:137](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L137) Unique event identifier @@ -36,7 +36,7 @@ Unique event identifier > `readonly` **eventType**: `string` -Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L139) +Defined in: [packages/events/src/types.ts:139](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L139) Event type / topic name @@ -46,7 +46,7 @@ Event type / topic name > `readonly` **metadata**: `ReadonlyMap`\<`string`, `string`\> -Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L145) +Defined in: [packages/events/src/types.ts:145](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L145) Event metadata (headers) @@ -56,7 +56,7 @@ Event metadata (headers) > `readonly` **publishedAt**: `Date` -Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L141) +Defined in: [packages/events/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L141) When the event was published @@ -66,7 +66,7 @@ When the event was published > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L135) +Defined in: [packages/events/src/types.ts:135](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L135) 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:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L147) +Defined in: [packages/events/src/types.ts:147](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L147) Acknowledge successful processing @@ -90,7 +90,7 @@ Acknowledge successful processing > **nack**(`requeue?`): `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:149](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L149) +Defined in: [packages/events/src/types.ts:149](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L149) 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 c46419a..f9f3fd6 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:155](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L155) +Defined in: [packages/events/src/types.ts:155](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L155) 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:158](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L158) +Defined in: [packages/events/src/types.ts:158](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L158) #### Returns @@ -24,7 +24,7 @@ Defined in: [packages/events/src/types.ts:158](https://github.com/Connectum-Fram > `readonly` **onNack**: (`requeue`) => `Promise`\<`void`\> -Defined in: [packages/events/src/types.ts:159](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L159) +Defined in: [packages/events/src/types.ts:159](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L159) #### Parameters @@ -42,7 +42,7 @@ Defined in: [packages/events/src/types.ts:159](https://github.com/Connectum-Fram > `readonly` **raw**: [`RawEvent`](RawEvent.md) -Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L156) +Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L156) *** @@ -50,4 +50,4 @@ Defined in: [packages/events/src/types.ts:156](https://github.com/Connectum-Fram > `readonly` **signal**: `AbortSignal` -Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L157) +Defined in: [packages/events/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L157) diff --git a/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md b/en/api/@connectum/events/types/interfaces/EventHandlerConfig.md index 4b1fb6e..6ed3957 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:178](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L178) +Defined in: [packages/events/src/types.ts:178](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L178) 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:180](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L180) +Defined in: [packages/events/src/types.ts:180](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L180) 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:182](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L182) +Defined in: [packages/events/src/types.ts:182](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L182) 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 1dd6b38..dbb54f1 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:199](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L199) +Defined in: [packages/events/src/types.ts:199](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L199) 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:205](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L205) +Defined in: [packages/events/src/types.ts:205](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L205) Typed handler function @@ -22,7 +22,7 @@ Typed handler function > `readonly` **method**: `DescMethod` -Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L203) +Defined in: [packages/events/src/types.ts:203](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L203) 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:207](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L207) +Defined in: [packages/events/src/types.ts:207](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L207) 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:201](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L201) +Defined in: [packages/events/src/types.ts:201](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L201) 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 f5517eb..1ae0cd2 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:216](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L216) +Defined in: [packages/events/src/types.ts:216](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L216) 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:218](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L218) +Defined in: [packages/events/src/types.ts:218](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L218) 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 ffaad03..3f81b28 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L43) +Defined in: [packages/events/src/types.ts:43](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L45) +Defined in: [packages/events/src/types.ts:45](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0eda30a..f5ffe4b 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:284](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L284) +Defined in: [packages/events/src/types.ts:284](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L284) 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:290](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L290) +Defined in: [packages/events/src/types.ts:290](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L290) 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:288](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L288) +Defined in: [packages/events/src/types.ts:288](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L288) Dead letter queue configuration @@ -32,6 +32,6 @@ Dead letter queue configuration > `optional` **retry?**: [`RetryOptions`](RetryOptions.md) -Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L286) +Defined in: [packages/events/src/types.ts:286](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L286) Retry configuration diff --git a/en/api/@connectum/events/types/interfaces/PublishOptions.md b/en/api/@connectum/events/types/interfaces/PublishOptions.md index c8fe883..29066f8 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L59) +Defined in: [packages/events/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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:65](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L65) +Defined in: [packages/events/src/types.ts:65](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L65) 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:69](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L69) +Defined in: [packages/events/src/types.ts:69](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L69) 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:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L67) +Defined in: [packages/events/src/types.ts:67](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L67) Additional metadata / headers @@ -42,7 +42,7 @@ Additional metadata / headers > `optional` **sync?**: `boolean` -Defined in: [packages/events/src/types.ts:63](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L63) +Defined in: [packages/events/src/types.ts:63](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L63) Wait for broker confirmation (default: false = fire-and-forget) @@ -52,6 +52,6 @@ Wait for broker confirmation (default: false = fire-and-forget) > `optional` **topic?**: `string` -Defined in: [packages/events/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L61) +Defined in: [packages/events/src/types.ts:61](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 564e168..484f499 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L16) +Defined in: [packages/events/src/types.ts:16](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L26) +Defined in: [packages/events/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L18) +Defined in: [packages/events/src/types.ts:18](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L20) +Defined in: [packages/events/src/types.ts:20](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L28) +Defined in: [packages/events/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L22) +Defined in: [packages/events/src/types.ts:22](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L24) +Defined in: [packages/events/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0869013..787e9f7 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L51) +Defined in: [packages/events/src/types.ts:51](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L53) +Defined in: [packages/events/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 34c56fe..0a4a384 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:251](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L251) +Defined in: [packages/events/src/types.ts:251](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L251) Retry middleware options @@ -12,7 +12,7 @@ Retry middleware options > `optional` **backoff?**: `"fixed"` \| `"exponential"` \| `"linear"` -Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L255) +Defined in: [packages/events/src/types.ts:255](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L255) Backoff strategy @@ -22,7 +22,7 @@ Backoff strategy > `optional` **initialDelay?**: `number` -Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L257) +Defined in: [packages/events/src/types.ts:257](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L257) 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:259](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L259) +Defined in: [packages/events/src/types.ts:259](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L259) 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:253](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L253) +Defined in: [packages/events/src/types.ts:253](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L253) Maximum retry attempts (default: 3) @@ -52,7 +52,7 @@ Maximum retry attempts (default: 3) > `optional` **multiplier?**: `number` -Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L261) +Defined in: [packages/events/src/types.ts:261](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L261) 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:263](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L263) +Defined in: [packages/events/src/types.ts:263](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L263) 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 c629a70..4ae216c 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:242](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L242) +Defined in: [packages/events/src/types.ts:242](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L242) 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 b9ca58f..46fddc3 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:237](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L237) +Defined in: [packages/events/src/types.ts:237](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L237) 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 885b0a3..ea4519b 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:224](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L224) +Defined in: [packages/events/src/types.ts:224](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L224) 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 6e7863b..c03289b 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L38) +Defined in: [packages/events/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2f67122..96479be 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:192](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L192) +Defined in: [packages/events/src/types.ts:192](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L192) 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 cd1e5ca..e78f317 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:169](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/events/src/types.ts#L169) +Defined in: [packages/events/src/types.ts:169](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/events/src/types.ts#L169) 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 39543a1..907f065 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:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L26) +Defined in: [HealthcheckManager.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L26) Healthcheck manager @@ -34,7 +34,7 @@ healthcheckManager.update(ServingStatus.SERVING); > **areAllHealthy**(): `boolean` -Defined in: [HealthcheckManager.ts:80](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L80) +Defined in: [HealthcheckManager.ts:80](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L80) Check if all services are healthy (SERVING) @@ -50,7 +50,7 @@ True if all services are SERVING > **clear**(): `void` -Defined in: [HealthcheckManager.ts:108](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L108) +Defined in: [HealthcheckManager.ts:108](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L108) Clear all services @@ -64,7 +64,7 @@ Clear all services > **getAllStatuses**(): `Map`\<`string`, [`ServiceStatus`](../types/interfaces/ServiceStatus.md)\> -Defined in: [HealthcheckManager.ts:71](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L71) +Defined in: [HealthcheckManager.ts:71](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L71) Get all services health status @@ -80,7 +80,7 @@ Map of service name to health status > **getStatus**(`service`): [`ServiceStatus`](../types/interfaces/ServiceStatus.md) \| `undefined` -Defined in: [HealthcheckManager.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L62) +Defined in: [HealthcheckManager.ts:62](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L62) Get service health status @@ -104,7 +104,7 @@ Service status or undefined if not found > **initialize**(`serviceNames`): `void` -Defined in: [HealthcheckManager.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L96) +Defined in: [HealthcheckManager.ts:96](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L96) Initialize services map @@ -130,7 +130,7 @@ Array of service names to track > **update**(`status`, `service?`): `void` -Defined in: [HealthcheckManager.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L39) +Defined in: [HealthcheckManager.ts:39](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L39) 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 7ab0f58..932a46e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/Healthcheck.ts#L84) +Defined in: [Healthcheck.ts:84](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 f643168..e558143 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:118](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/HealthcheckManager.ts#L118) +Defined in: [HealthcheckManager.ts:118](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/healthcheck/src/HealthcheckManager.ts#L118) 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 c3d21e7..f8f16d1 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/httpHandler.ts#L58) +Defined in: [httpHandler.ts:58](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 5cde3c4..01e713b 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/httpHandler.ts#L111) +Defined in: [httpHandler.ts:111](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 99dc1ee..1097501 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L32) +Defined in: [types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L38) +Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L51) +Defined in: [types.ts:51](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L44) +Defined in: [types.ts:44](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 194a85e..a51a6f9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L20) +Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 a62f70a..f769ce2 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 e3cbe67..007f969 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 63e4f25..8be4c60 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/healthcheck/src/Healthcheck.ts#L41) +Defined in: [Healthcheck.ts:41](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 25f7552..b29f98d 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/bulkhead.ts#L56) +Defined in: [bulkhead.ts:56](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 5973b68..6a12f0f 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:61](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/circuit-breaker.ts#L61) +Defined in: [circuit-breaker.ts:61](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/circuit-breaker.ts#L61) Create circuit breaker interceptor diff --git a/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md b/en/api/@connectum/interceptors/defaults/functions/createDefaultInterceptors.md index 11281d2..2aef071 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:129](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L129) +Defined in: [defaults.ts:129](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L129) Creates the default interceptor chain with the specified configuration. diff --git a/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md b/en/api/@connectum/interceptors/defaults/interfaces/DefaultInterceptorOptions.md index 13f39cc..6e5c9ce 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:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L33) +Defined in: [defaults.ts:33](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L33) Configuration options for the default interceptor chain. @@ -20,7 +20,7 @@ All interceptors are enabled by default except fallback and serializer > `optional` **bulkhead?**: `boolean` \| [`BulkheadOptions`](../../interfaces/BulkheadOptions.md) -Defined in: [defaults.ts:53](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L53) +Defined in: [defaults.ts:53](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L53) Bulkhead interceptor. Limits concurrent requests to prevent resource exhaustion. @@ -37,7 +37,7 @@ true (10/10) > `optional` **circuitBreaker?**: `boolean` \| [`CircuitBreakerOptions`](../../interfaces/CircuitBreakerOptions.md) -Defined in: [defaults.ts:60](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L60) +Defined in: [defaults.ts:60](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L60) Circuit breaker interceptor. Prevents cascading failures by breaking circuit on consecutive errors. @@ -54,7 +54,7 @@ true (5 failures) > `optional` **errorHandler?**: `boolean` \| [`ErrorHandlerOptions`](../../interfaces/ErrorHandlerOptions.md) -Defined in: [defaults.ts:39](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L39) +Defined in: [defaults.ts:39](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L39) Error handler interceptor (first in chain). Transforms errors into ConnectError with proper codes. @@ -71,7 +71,7 @@ true > `optional` **fallback?**: `boolean` \| [`FallbackOptions`](../../interfaces/FallbackOptions.md)\<`unknown`\> -Defined in: [defaults.ts:75](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L75) +Defined in: [defaults.ts:75](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L75) Fallback interceptor. Provides graceful degradation when service fails. @@ -89,7 +89,7 @@ false > `optional` **retry?**: `boolean` \| [`RetryOptions`](../../interfaces/RetryOptions.md) -Defined in: [defaults.ts:67](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L67) +Defined in: [defaults.ts:67](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L67) Retry interceptor. Retries transient failures with exponential backoff. @@ -106,7 +106,7 @@ true (3 retries) > `optional` **serializer?**: `boolean` \| [`SerializerOptions`](../../interfaces/SerializerOptions.md) -Defined in: [defaults.ts:90](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L90) +Defined in: [defaults.ts:90](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L90) Serializer interceptor (last in chain). Auto JSON serialization for ConnectRPC responses. @@ -124,7 +124,7 @@ false > `optional` **timeout?**: `boolean` \| [`TimeoutOptions`](../../interfaces/TimeoutOptions.md) -Defined in: [defaults.ts:46](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L46) +Defined in: [defaults.ts:46](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L46) Timeout interceptor. Enforces request deadline before any processing. @@ -141,7 +141,7 @@ true (30s) > `optional` **validation?**: `boolean` -Defined in: [defaults.ts:82](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/defaults.ts#L82) +Defined in: [defaults.ts:82](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/defaults.ts#L82) 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 d4ea593..0541fcc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/errorHandler.ts#L48) +Defined in: [errorHandler.ts:48](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 66eb341..60eadbc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/fallback.ts#L57) +Defined in: [fallback.ts:57](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0b24cab..b4bb0b2 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:166](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L166) +Defined in: [types.ts:166](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L166) Bulkhead interceptor options @@ -12,7 +12,7 @@ Bulkhead interceptor options > `optional` **capacity?**: `number` -Defined in: [types.ts:171](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L171) +Defined in: [types.ts:171](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L171) Maximum number of concurrent requests @@ -28,7 +28,7 @@ Maximum number of concurrent requests > `optional` **queueSize?**: `number` -Defined in: [types.ts:177](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L177) +Defined in: [types.ts:177](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L177) Maximum queue size for pending requests @@ -44,7 +44,7 @@ Maximum queue size for pending requests > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:183](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L183) +Defined in: [types.ts:183](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L183) Skip bulkhead for streaming calls diff --git a/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md b/en/api/@connectum/interceptors/interfaces/CircuitBreakerOptions.md index 267898b..396b070 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L126) +Defined in: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L126) Circuit breaker interceptor options @@ -12,7 +12,7 @@ Circuit breaker interceptor options > `optional` **halfOpenAfter?**: `number` -Defined in: [types.ts:137](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L137) +Defined in: [types.ts:137](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L137) Time in milliseconds to wait before attempting to close circuit @@ -28,7 +28,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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L143) +Defined in: [types.ts:143](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L143) Skip circuit breaker for streaming calls @@ -44,7 +44,7 @@ true > `optional` **threshold?**: `number` -Defined in: [types.ts:131](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L131) +Defined in: [types.ts:131](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0afb08c..ce99030 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L21) +Defined in: [types.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L33) +Defined in: [types.ts:33](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L27) +Defined in: [types.ts:27](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L39) +Defined in: [types.ts:39](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 ea44289..60e07d6 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:189](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L189) +Defined in: [types.ts:189](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L189) Fallback interceptor options @@ -18,7 +18,7 @@ Fallback interceptor options > **handler**: (`error`) => `T` \| `Promise`\<`T`\> -Defined in: [types.ts:193](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L193) +Defined in: [types.ts:193](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L193) Fallback function to call on error @@ -38,7 +38,7 @@ Fallback function to call on error > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:199](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L199) +Defined in: [types.ts:199](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L199) Skip fallback for streaming calls diff --git a/en/api/@connectum/interceptors/interfaces/LoggerOptions.md b/en/api/@connectum/interceptors/interfaces/LoggerOptions.md index 50915b1..3685354 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L45) +Defined in: [types.ts:45](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L45) Logger interceptor options @@ -12,7 +12,7 @@ Logger interceptor options > `optional` **level?**: `"error"` \| `"debug"` \| `"info"` \| `"warn"` -Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L50) +Defined in: [types.ts:50](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L62) +Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L56) +Defined in: [types.ts:56](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 06572ea..d840f36 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L91) +Defined in: [types.ts:91](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L102) +Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L108) +Defined in: [types.ts:108](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L96) +Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L120) +Defined in: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L114) +Defined in: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 1b7d373..eb384ab 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L68) +Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L79) +Defined in: [types.ts:79](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L85) +Defined in: [types.ts:85](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L73) +Defined in: [types.ts:73](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 1b93112..177b874 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:149](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L149) +Defined in: [types.ts:149](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L149) Timeout interceptor options @@ -12,7 +12,7 @@ Timeout interceptor options > `optional` **duration?**: `number` -Defined in: [types.ts:154](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L154) +Defined in: [types.ts:154](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L154) Request timeout in milliseconds @@ -28,7 +28,7 @@ Request timeout in milliseconds > `optional` **skipStreaming?**: `boolean` -Defined in: [types.ts:160](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L160) +Defined in: [types.ts:160](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L160) 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 b547f3c..2121efe 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/logger.ts#L86) +Defined in: [logger.ts:86](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 37c6ba7..794b12a 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/method-filter.ts#L130) +Defined in: [method-filter.ts:130](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 c968084..e557c8c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/retry.ts#L44) +Defined in: [retry.ts:44](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9883825..c545892 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/serializer.ts#L84) +Defined in: [serializer.ts:84](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 985312f..7164c1e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/timeout.ts#L55) +Defined in: [timeout.ts:55](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 8299940..0d1d42c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L16) +Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 3ab4cb5..af13260 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:224](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/interceptors/src/types.ts#L224) +Defined in: [types.ts:224](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/interceptors/src/types.ts#L224) Method pattern to interceptors mapping. diff --git a/en/api/@connectum/otel/attributes/index.md b/en/api/@connectum/otel/attributes/index.md index 8d42918..c048d2c 100644 --- a/en/api/@connectum/otel/attributes/index.md +++ b/en/api/@connectum/otel/attributes/index.md @@ -15,6 +15,8 @@ Based on: ## Variables +- [ATTR\_CONNECTUM\_TRANSPORT](variables/ATTR_CONNECTUM_TRANSPORT.md) +- [ATTR\_CONNECTUM\_TRANSPORT\_METRIC](variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md) - [ATTR\_ERROR\_TYPE](variables/ATTR_ERROR_TYPE.md) - [ATTR\_NETWORK\_PEER\_ADDRESS](variables/ATTR_NETWORK_PEER_ADDRESS.md) - [ATTR\_NETWORK\_PEER\_PORT](variables/ATTR_NETWORK_PEER_PORT.md) @@ -31,5 +33,7 @@ Based on: - [ATTR\_SERVER\_PORT](variables/ATTR_SERVER_PORT.md) - [ConnectErrorCode](variables/ConnectErrorCode.md) - [ConnectErrorCodeName](variables/ConnectErrorCodeName.md) +- [CONNECTUM\_INTERNAL\_TRANSPORT\_HEADER](variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md) +- [CONNECTUM\_INTERNAL\_TRANSPORT\_IN\_PROCESS](variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md) - [RPC\_MESSAGE\_EVENT](variables/RPC_MESSAGE_EVENT.md) - [RPC\_SYSTEM\_CONNECT\_RPC](variables/RPC_SYSTEM_CONNECT_RPC.md) diff --git a/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md b/en/api/@connectum/otel/attributes/type-aliases/ConnectErrorCode.md index d9784f9..1b00b66 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:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L38) +Defined in: [packages/otel/src/attributes.ts:66](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 new file mode 100644 index 0000000..51f1680 --- /dev/null +++ b/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT.md @@ -0,0 +1,23 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/otel](../../index.md) / [attributes](../index.md) / ATTR\_CONNECTUM\_TRANSPORT + +# Variable: ATTR\_CONNECTUM\_TRANSPORT + +> `const` **ATTR\_CONNECTUM\_TRANSPORT**: `"connectum.transport"` = `"connectum.transport"` + +Defined in: [packages/otel/src/attributes.ts:43](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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. + +Values: + - `"in-process"` — the call traversed `createLocalTransport` + - `"http"` — the call traversed `createGrpcTransport` / + `createConnectTransport` (the network path) + +Parity tests strip this attribute before structural diffing so that the +remaining shape (spans, events, metric instruments) is invariant across +transports. + +## See + +ATTR_CONNECTUM_TRANSPORT_METRIC for the metric-label counterpart 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 new file mode 100644 index 0000000..960865b --- /dev/null +++ b/en/api/@connectum/otel/attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md @@ -0,0 +1,12 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/otel](../../index.md) / [attributes](../index.md) / ATTR\_CONNECTUM\_TRANSPORT\_METRIC + +# Variable: ATTR\_CONNECTUM\_TRANSPORT\_METRIC + +> `const` **ATTR\_CONNECTUM\_TRANSPORT\_METRIC**: `"transport"` = `"transport"` + +Defined in: [packages/otel/src/attributes.ts:50](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/attributes.ts#L50) + +Metric-label counterpart of [ATTR\_CONNECTUM\_TRANSPORT](ATTR_CONNECTUM_TRANSPORT.md). + +Uses the short, lowercase form to align with OpenTelemetry metric +label conventions and existing `network.*` keys. 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 93c70bd..e1ddccc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L20) +Defined in: [packages/otel/src/attributes.ts:20](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 c9c2be3..ee4d1df 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L25) +Defined in: [packages/otel/src/attributes.ts:25](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 23ff1ec..7cbaf42 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L26) +Defined in: [packages/otel/src/attributes.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d23c9cb..d7eeb2e 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L23) +Defined in: [packages/otel/src/attributes.ts:23](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 1dfb779..2654d21 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L24) +Defined in: [packages/otel/src/attributes.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 c2320e1..e653fef 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L19) +Defined in: [packages/otel/src/attributes.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2e32b32..d9644bd 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:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L31) +Defined in: [packages/otel/src/attributes.ts:59](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 259db0e..fc9a2ae 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:30](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L30) +Defined in: [packages/otel/src/attributes.ts:58](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 ebd3c8d..859b04d 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:32](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L32) +Defined in: [packages/otel/src/attributes.ts:60](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 f546bbc..e5509c0 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L18) +Defined in: [packages/otel/src/attributes.ts:18](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 64ad7d7..38cd78c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L17) +Defined in: [packages/otel/src/attributes.ts:17](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 192dbf5..182f0aa 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L16) +Defined in: [packages/otel/src/attributes.ts:16](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 700ac7b..782ca15 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L21) +Defined in: [packages/otel/src/attributes.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 48ab66b..533d1f3 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L22) +Defined in: [packages/otel/src/attributes.ts:22](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 new file mode 100644 index 0000000..0d610d2 --- /dev/null +++ b/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md @@ -0,0 +1,9 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/otel](../../index.md) / [attributes](../index.md) / CONNECTUM\_INTERNAL\_TRANSPORT\_HEADER + +# Variable: CONNECTUM\_INTERNAL\_TRANSPORT\_HEADER + +> `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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 new file mode 100644 index 0000000..919c5a9 --- /dev/null +++ b/en/api/@connectum/otel/attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md @@ -0,0 +1,9 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/otel](../../index.md) / [attributes](../index.md) / CONNECTUM\_INTERNAL\_TRANSPORT\_IN\_PROCESS + +# Variable: CONNECTUM\_INTERNAL\_TRANSPORT\_IN\_PROCESS + +> `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/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d88ebd4..6828a3a 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:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L38) +Defined in: [packages/otel/src/attributes.ts:66](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 afc2d85..f261713 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:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L62) +Defined in: [packages/otel/src/attributes.ts:90](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 68d5264..db5704f 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:29](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L29) +Defined in: [packages/otel/src/attributes.ts:57](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0777517..d11be06 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/attributes.ts#L13) +Defined in: [packages/otel/src/attributes.ts:13](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d31e1bd..c07f62f 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:58](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/client-interceptor.ts#L58) +Defined in: [packages/otel/src/client-interceptor.ts:59](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d1d8fa9..f1387eb 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L100) +Defined in: [packages/otel/src/config.ts:100](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 1e91334..c9c9a39 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L81) +Defined in: [packages/otel/src/config.ts:81](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 58349cd..d7dd294 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L65) +Defined in: [packages/otel/src/config.ts:65](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2fd0758..b19cf85 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L116) +Defined in: [packages/otel/src/config.ts:116](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/config.ts#L116) Gets service metadata from environment variables diff --git a/en/api/@connectum/otel/index.md b/en/api/@connectum/otel/index.md index 4c1400c..2657c92 100644 --- a/en/api/@connectum/otel/index.md +++ b/en/api/@connectum/otel/index.md @@ -50,6 +50,18 @@ ## References +### ATTR\_CONNECTUM\_TRANSPORT + +Re-exports [ATTR_CONNECTUM_TRANSPORT](attributes/variables/ATTR_CONNECTUM_TRANSPORT.md) + +*** + +### ATTR\_CONNECTUM\_TRANSPORT\_METRIC + +Re-exports [ATTR_CONNECTUM_TRANSPORT_METRIC](attributes/variables/ATTR_CONNECTUM_TRANSPORT_METRIC.md) + +*** + ### ATTR\_ERROR\_TYPE Re-exports [ATTR_ERROR_TYPE](attributes/variables/ATTR_ERROR_TYPE.md) @@ -134,6 +146,18 @@ Re-exports [ConnectErrorCodeName](attributes/variables/ConnectErrorCodeName.md) *** +### CONNECTUM\_INTERNAL\_TRANSPORT\_HEADER + +Re-exports [CONNECTUM_INTERNAL_TRANSPORT_HEADER](attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_HEADER.md) + +*** + +### CONNECTUM\_INTERNAL\_TRANSPORT\_IN\_PROCESS + +Re-exports [CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS](attributes/variables/CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS.md) + +*** + ### createOtelClientInterceptor Re-exports [createOtelClientInterceptor](client-interceptor/functions/createOtelClientInterceptor.md) @@ -158,6 +182,12 @@ Re-exports [createRpcServerMetrics](metrics/functions/createRpcServerMetrics.md) *** +### detectConnectumTransport + +Re-exports [detectConnectumTransport](shared/functions/detectConnectumTransport.md) + +*** + ### estimateMessageSize Re-exports [estimateMessageSize](shared/functions/estimateMessageSize.md) diff --git a/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md b/en/api/@connectum/otel/interceptor/functions/createOtelInterceptor.md index 8e7529e..5c63fba 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:51](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/interceptor.ts#L51) +Defined in: [packages/otel/src/interceptor.ts:52](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2e6fdf6..744f2be 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L48) +Defined in: [packages/otel/src/config.ts:48](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L52) +Defined in: [packages/otel/src/config.ts:52](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L49) +Defined in: [packages/otel/src/config.ts:49](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L50) +Defined in: [packages/otel/src/config.ts:50](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L51) +Defined in: [packages/otel/src/config.ts:51](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 97a4fde..18b51f9 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L40) +Defined in: [packages/otel/src/config.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L41) +Defined in: [packages/otel/src/config.ts:41](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L42) +Defined in: [packages/otel/src/config.ts:42](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 5a26f4d..f5abaee 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L31) +Defined in: [packages/otel/src/config.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L34) +Defined in: [packages/otel/src/config.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L33) +Defined in: [packages/otel/src/config.ts:33](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L32) +Defined in: [packages/otel/src/config.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 651afaf..1b800cc 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L29) +Defined in: [packages/otel/src/types.ts:29](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 d65199c..5290862 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L75) +Defined in: [packages/otel/src/types.ts:75](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L80) +Defined in: [packages/otel/src/types.ts:80](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L86) +Defined in: [packages/otel/src/types.ts:86](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 c4b89ef..05fba2b 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L53) +Defined in: [packages/otel/src/types.ts:53](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L40) +Defined in: [packages/otel/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L37) +Defined in: [packages/otel/src/types.ts:37](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L47) +Defined in: [packages/otel/src/types.ts:47](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L64) +Defined in: [packages/otel/src/types.ts:64](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L69) +Defined in: [packages/otel/src/types.ts:69](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L59) +Defined in: [packages/otel/src/types.ts:59](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L34) +Defined in: [packages/otel/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L31) +Defined in: [packages/otel/src/types.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 b869b6c..e2b5f2b 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L133) +Defined in: [packages/otel/src/types.ts:133](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L157) +Defined in: [packages/otel/src/types.ts:157](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L144) +Defined in: [packages/otel/src/types.ts:144](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L141) +Defined in: [packages/otel/src/types.ts:141](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L138) +Defined in: [packages/otel/src/types.ts:138](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L152) +Defined in: [packages/otel/src/types.ts:152](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 1ac3b9a..ef2afe7 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L104) +Defined in: [packages/otel/src/types.ts:104](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L122) +Defined in: [packages/otel/src/types.ts:122](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L127) +Defined in: [packages/otel/src/types.ts:127](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L108) +Defined in: [packages/otel/src/types.ts:108](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L116) +Defined in: [packages/otel/src/types.ts:116](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 cc4f195..068b943 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L28) +Defined in: [packages/otel/src/logger.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 b6afb51..8167ac5 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L11) +Defined in: [packages/otel/src/logger.ts:11](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L15) +Defined in: [packages/otel/src/logger.ts:15](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L16) +Defined in: [packages/otel/src/logger.ts:16](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L14) +Defined in: [packages/otel/src/logger.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L12) +Defined in: [packages/otel/src/logger.ts:12](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L13) +Defined in: [packages/otel/src/logger.ts:13](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9b489ef..a2ada76 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L7) +Defined in: [packages/otel/src/logger.ts:7](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/logger.ts#L8) +Defined in: [packages/otel/src/logger.ts:8](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 7712fd4..bc72f2f 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/meter.ts#L14) +Defined in: [packages/otel/src/meter.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 a53e152..da690fb 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L106) +Defined in: [packages/otel/src/metrics.ts:106](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 8a3f3a8..d0b542c 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L65) +Defined in: [packages/otel/src/metrics.ts:65](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 60dcc84..350b516 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L34) +Defined in: [packages/otel/src/metrics.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L36) +Defined in: [packages/otel/src/metrics.ts:36](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L38) +Defined in: [packages/otel/src/metrics.ts:38](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L40) +Defined in: [packages/otel/src/metrics.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 18766d8..435e659 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L19) +Defined in: [packages/otel/src/metrics.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L21) +Defined in: [packages/otel/src/metrics.ts:21](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L23) +Defined in: [packages/otel/src/metrics.ts:23](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/metrics.ts#L25) +Defined in: [packages/otel/src/metrics.ts:25](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/getProvider.md b/en/api/@connectum/otel/provider/functions/getProvider.md index fda745a..981a7f0 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:275](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L275) +Defined in: [packages/otel/src/provider.ts:275](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L275) 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 306e68d..382dfb8 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:261](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L261) +Defined in: [packages/otel/src/provider.ts:261](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L261) Initialize the OpenTelemetry provider with explicit options. diff --git a/en/api/@connectum/otel/provider/functions/shutdownProvider.md b/en/api/@connectum/otel/provider/functions/shutdownProvider.md index 74af04d..bcc9fea 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:288](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L288) +Defined in: [packages/otel/src/provider.ts:288](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L288) 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 479f6bb..abf0ede 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:31](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L31) +Defined in: [packages/otel/src/provider.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L31) Options for initializing the OpenTelemetry provider @@ -12,7 +12,7 @@ Options for initializing the OpenTelemetry provider > `optional` **serviceName?**: `string` -Defined in: [packages/otel/src/provider.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L33) +Defined in: [packages/otel/src/provider.ts:33](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L33) Override service name (defaults to OTEL_SERVICE_NAME or npm_package_name) @@ -22,7 +22,7 @@ Override service name (defaults to OTEL_SERVICE_NAME or npm_package_name) > `optional` **serviceVersion?**: `string` -Defined in: [packages/otel/src/provider.ts:35](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L35) +Defined in: [packages/otel/src/provider.ts:35](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L35) Override service version (defaults to npm_package_version) @@ -32,6 +32,6 @@ Override service version (defaults to npm_package_version) > `optional` **settings?**: `Partial`\<[`OTLPSettings`](../../interfaces/OTLPSettings.md)\> -Defined in: [packages/otel/src/provider.ts:37](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/provider.ts#L37) +Defined in: [packages/otel/src/provider.ts:37](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/provider.ts#L37) Override OTLP exporter settings (defaults to env-based config) diff --git a/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md b/en/api/@connectum/otel/shared/functions/applyAttributeFilter.md index e3080fd..975c9dc 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:181](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L181) +Defined in: [packages/otel/src/shared.ts:198](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 f794664..cbe0f33 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:158](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L158) +Defined in: [packages/otel/src/shared.ts:160](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2f773f2..0b15a83 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:129](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L129) +Defined in: [packages/otel/src/shared.ts:131](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 new file mode 100644 index 0000000..364ce1c --- /dev/null +++ b/en/api/@connectum/otel/shared/functions/detectConnectumTransport.md @@ -0,0 +1,28 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/otel](../../index.md) / [shared](../index.md) / detectConnectumTransport + +# Function: detectConnectumTransport() + +> **detectConnectumTransport**(`headers`): `"http"` \| `"in-process"` + +Defined in: [packages/otel/src/shared.ts:187](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/shared.ts#L187) + +Connectum transport identifier observed from request headers. + +`@connectum/core`'s `createLocalTransport` sets a synthetic request header +(`connectum-internal-transport: in-process`) on every outgoing call so that +the OTel interceptors can tag spans and metrics with the originating +transport without parsing the synthetic `https://in-memory/...` URL. + +## Parameters + +### headers + +`Headers` + +The request headers (Connect `req.header`) + +## Returns + +`"http"` \| `"in-process"` + +`"in-process"` if the marker is present, `"http"` otherwise. diff --git a/en/api/@connectum/otel/shared/functions/estimateMessageSize.md b/en/api/@connectum/otel/shared/functions/estimateMessageSize.md index 66e7ef6..92a4341 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:49](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L49) +Defined in: [packages/otel/src/shared.ts:51](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 c400a89..823fdf2 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:81](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L81) +Defined in: [packages/otel/src/shared.ts:83](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/index.md b/en/api/@connectum/otel/shared/index.md index cfb6dc5..c457bf9 100644 --- a/en/api/@connectum/otel/shared/index.md +++ b/en/api/@connectum/otel/shared/index.md @@ -16,5 +16,6 @@ and createOtelClientInterceptor(). - [applyAttributeFilter](functions/applyAttributeFilter.md) - [buildBaseAttributes](functions/buildBaseAttributes.md) - [buildErrorAttributes](functions/buildErrorAttributes.md) +- [detectConnectumTransport](functions/detectConnectumTransport.md) - [estimateMessageSize](functions/estimateMessageSize.md) - [wrapAsyncIterable](functions/wrapAsyncIterable.md) diff --git a/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md b/en/api/@connectum/otel/shared/interfaces/BaseAttributeParams.md index e138aa6..2cb5ee6 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:145](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L145) +Defined in: [packages/otel/src/shared.ts:147](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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:147](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L147) +Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/shared.ts#L149) *** @@ -20,7 +20,7 @@ Defined in: [packages/otel/src/shared.ts:147](https://github.com/Connectum-Frame > **serverAddress**: `string` -Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L148) +Defined in: [packages/otel/src/shared.ts:150](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/shared.ts#L150) *** @@ -28,7 +28,7 @@ Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Frame > `optional` **serverPort?**: `number` -Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L149) +Defined in: [packages/otel/src/shared.ts:151](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/otel/src/shared.ts#L151) *** @@ -36,4 +36,4 @@ Defined in: [packages/otel/src/shared.ts:149](https://github.com/Connectum-Frame > **service**: `string` -Defined in: [packages/otel/src/shared.ts:146](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/shared.ts#L146) +Defined in: [packages/otel/src/shared.ts:148](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 def5921..cbc6ab6 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/traceAll.ts#L36) +Defined in: [packages/otel/src/traceAll.ts:36](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 2acdda3..1de15dd 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/traced.ts#L31) +Defined in: [packages/otel/src/traced.ts:31](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 0681ef9..0ec17e8 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/tracer.ts#L14) +Defined in: [packages/otel/src/tracer.ts:14](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 6cdae2c..aaadb63 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L94) +Defined in: [packages/otel/src/types.ts:94](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 932b96c..4053092 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L19) +Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 934b504..32c0c99 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L99) +Defined in: [packages/otel/src/types.ts:99](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 b477712..71e3228 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L24) +Defined in: [packages/otel/src/types.ts:24](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 eb3294f..a4c0f54 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/types.ts#L15) +Defined in: [packages/otel/src/types.ts:15](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 9a032b6..240ed49 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/otel/src/config.ts#L19) +Defined in: [packages/otel/src/config.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 c771330..70c1c63 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/reflection/src/Reflection.ts#L43) +Defined in: [Reflection.ts:43](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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 4776fa4..1dd1182 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/reflection/src/utils.ts#L19) +Defined in: [utils.ts:19](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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.md b/en/api/@connectum/test-fixtures/index.md new file mode 100644 index 0000000..106a1d0 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index.md @@ -0,0 +1,8 @@ +[Connectum API Reference](../../index.md) / @connectum/test-fixtures + +# @connectum/test-fixtures + +## Modules + +- [index](index/index.md) +- [types](types/index.md) diff --git a/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md b/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md new file mode 100644 index 0000000..691059e --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/assertConnectError.md @@ -0,0 +1,62 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / assertConnectError + +# Function: assertConnectError() + +> **assertConnectError**(`error`, `expectedCode`, `messagePattern?`): `asserts error is ConnectError` + +Defined in: assertions.ts:44 + +Assert that a thrown value is a ConnectError with the expected +gRPC status code and, optionally, a message matching a pattern. + +This is a TypeScript +[assertion function](https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates): +after a successful call the compiler narrows `error` to `ConnectError`. + +**Note on message format**: ConnectError messages include a code prefix, +e.g. `[not_found] user not found`. The `messagePattern` is matched against +the full message string. Use a `RegExp` for flexible matching. + +## Parameters + +### error + +`unknown` + +The value to check (typically from a `catch` block). + +### expectedCode + +`Code` + +Expected gRPC/Connect status code. + +### messagePattern? + +`string` \| `RegExp` + +Optional substring or RegExp to match against + `error.message`. + +## Returns + +`asserts error is ConnectError` + +## Throws + +When any of the checks fail. + +## Example + +```ts +import { Code, ConnectError } from "@connectrpc/connect"; +import { assertConnectError } from "@connectum/testing"; + +try { + await client.getUser({ id: "missing" }); +} catch (err) { + assertConnectError(err, Code.NotFound, "user not found"); + // err is now typed as ConnectError + console.log(err.code); // Code.NotFound +} +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md b/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md new file mode 100644 index 0000000..2ebb560 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createFakeMethod.md @@ -0,0 +1,51 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createFakeMethod + +# Function: createFakeMethod() + +> **createFakeMethod**(`service`, `name`, `options?`): `DescMethod` + +Defined in: fake-service.ts:72 + +Create a fake DescMethod descriptor attached to a service. + +When `options.register` is `true`, the method is pushed into +`service.methods` and added to `service.method` (keyed by `localName`). +This is required for tests that iterate over service methods +(e.g., `getPublicMethods()`). + +## Parameters + +### service + +`DescService` + +The parent `DescService` (typically from [createFakeService](createFakeService.md)). + +### name + +`string` + +The RPC method name (PascalCase, e.g. `"GetUser"`). + +### options? + +[`FakeMethodOptions`](../../types/interfaces/FakeMethodOptions.md) + +Optional configuration for method kind and registration. + +## Returns + +`DescMethod` + +A fake `DescMethod` suitable for unit/integration tests. + +## Example + +```ts +import { createFakeService, createFakeMethod } from "@connectum/testing"; + +const svc = createFakeService(); +const method = createFakeMethod(svc, "GetUser", { register: true }); +// method.localName === "getUser" +// svc.methods.length === 1 +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createFakeService.md b/en/api/@connectum/test-fixtures/index/functions/createFakeService.md new file mode 100644 index 0000000..bcbfb8d --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createFakeService.md @@ -0,0 +1,38 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createFakeService + +# Function: createFakeService() + +> **createFakeService**(`options?`): `DescService` + +Defined in: fake-service.ts:34 + +Create a fake DescService descriptor for testing. + +The returned object has the same shape as a real `DescService` produced by +the protobuf compiler, but contains only the fields commonly accessed in +interceptor and utility code. The `methods` array and `method` lookup map +start empty; use [createFakeMethod](createFakeMethod.md) with `register: true` to populate them. + +## Parameters + +### options? + +[`FakeServiceOptions`](../../types/interfaces/FakeServiceOptions.md) + +Optional overrides for service name and typeName. + +## Returns + +`DescService` + +A fake `DescService` suitable for unit/integration tests. + +## Example + +```ts +import { createFakeService } from "@connectum/testing"; + +const svc = createFakeService({ typeName: "acme.v1.UserService" }); +// svc.typeName === "acme.v1.UserService" +// svc.name === "UserService" +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md b/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md new file mode 100644 index 0000000..208a1cc --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockDescField.md @@ -0,0 +1,42 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockDescField + +# Function: createMockDescField() + +> **createMockDescField**(`localName`, `options?`): `DescField` + +Defined in: mock-desc.ts:62 + +Create a mock DescField descriptor. + +Produces a minimal object that satisfies the `DescField` shape expected by +ConnectRPC interceptors and protobuf utilities. + +## Parameters + +### localName + +`string` + +The field's local (camelCase) name. + +### options? + +[`MockDescFieldOptions`](../../types/interfaces/MockDescFieldOptions.md) + +Optional overrides for field number, scalar type, and sensitivity. + +## Returns + +`DescField` + +A mock `DescField` object. + +## Example + +```ts +import { createMockDescField } from "@connectum/testing"; + +const field = createMockDescField("userId", { type: "int32", fieldNumber: 1 }); +// field.localName === "userId" +// field.scalar === 5 (INT32) +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md b/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md new file mode 100644 index 0000000..5408dd4 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockDescMessage.md @@ -0,0 +1,50 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockDescMessage + +# Function: createMockDescMessage() + +> **createMockDescMessage**(`typeName`, `options?`): `DescMessage` + +Defined in: mock-desc.ts:109 + +Create a mock DescMessage descriptor with all required structural +properties. + +**Important**: the returned object always includes `members: []` which is +required by `create()` from `@bufbuild/protobuf` — without it the runtime +crashes. + +## Parameters + +### typeName + +`string` + +Fully-qualified protobuf type name (e.g. `"acme.v1.User"`). + +### options? + +[`MockDescMessageOptions`](../../types/interfaces/MockDescMessageOptions.md) + +Optional field and oneof definitions. + +## Returns + +`DescMessage` + +A mock `DescMessage` object. + +## Example + +```ts +import { createMockDescMessage } from "@connectum/testing"; + +const msg = createMockDescMessage("acme.v1.User", { + fields: [ + { name: "id", type: "int32" }, + { name: "email", type: "string" }, + ], +}); +// msg.typeName === "acme.v1.User" +// msg.name === "User" +// msg.fields === [DescField, DescField] +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md b/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md new file mode 100644 index 0000000..d411192 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockDescMethod.md @@ -0,0 +1,48 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockDescMethod + +# Function: createMockDescMethod() + +> **createMockDescMethod**(`name`, `options?`): `DescMethod` + +Defined in: mock-desc.ts:172 + +Create a mock DescMethod descriptor. + +When `input` or `output` are not provided, default mock messages are created +automatically based on the method name (e.g. `test.GetUserRequest` / +`test.GetUserResponse`). + +## Parameters + +### name + +`string` + +The RPC method name (PascalCase by convention). + +### options? + +[`MockDescMethodOptions`](../../types/interfaces/MockDescMethodOptions.md) + +Optional overrides for kind, input/output, and redaction. + +## Returns + +`DescMethod` + +A mock `DescMethod` object. + +## Example + +```ts +import { createMockDescMethod, createMockDescMessage } from "@connectum/testing"; + +const method = createMockDescMethod("GetUser"); +// method.name === "GetUser" +// method.localName === "getUser" +// method.methodKind === "unary" + +const streaming = createMockDescMethod("ListUsers", { + kind: "server_streaming", +}); +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockFn.md b/en/api/@connectum/test-fixtures/index/functions/createMockFn.md new file mode 100644 index 0000000..786bbee --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockFn.md @@ -0,0 +1,39 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockFn + +# Function: createMockFn() + +> **createMockFn**\<`F`\>(`impl`): [`MockFn`](../interfaces/MockFn.md)\<`F`\> + +Defined in: mock-compat.ts:54 + +Create a portable mock function that wraps `impl` and records every call. + +## Type Parameters + +### F + +`F` *extends* (...`args`) => `any` + +## Parameters + +### impl + +`F` + +The underlying implementation to delegate to. + +## Returns + +[`MockFn`](../interfaces/MockFn.md)\<`F`\> + +A spy-enabled wrapper whose `.mock` property exposes call metadata. + +## Example + +```ts +const add = createMockFn((a: number, b: number) => a + b); +add(1, 2); +add(3, 4); +add.mock.callCount(); // 2 +add.mock.calls[0].arguments; // [1, 2] +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockNext.md b/en/api/@connectum/test-fixtures/index/functions/createMockNext.md new file mode 100644 index 0000000..6da1f15 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockNext.md @@ -0,0 +1,37 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockNext + +# Function: createMockNext() + +> **createMockNext**(`options?`): `any` + +Defined in: mock-next.ts:36 + +Create a mock `next` handler that resolves with a successful response. + +The returned function is a spy (via [createMockFn](createMockFn.md)), so callers can +inspect `next.mock.calls` and `next.mock.callCount()` after the test. + +## Parameters + +### options? + +[`MockNextOptions`](../../types/interfaces/MockNextOptions.md) + +Optional overrides for the response payload and stream flag. + +## Returns + +`any` + +A spy-enabled async function matching the ConnectRPC `next` signature. + +## Example + +```ts +import { createMockNext } from "@connectum/testing"; + +const next = createMockNext({ message: { id: 1 } }); +const res = await next({}); +// res.message => { id: 1 } +// next.mock.callCount() => 1 +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md b/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md new file mode 100644 index 0000000..a323d0d --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockNextError.md @@ -0,0 +1,44 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockNextError + +# Function: createMockNextError() + +> **createMockNextError**(`code`, `message?`): `any` + +Defined in: mock-next.ts:68 + +Create a mock `next` handler that always throws a ConnectError. + +Useful for testing how interceptors handle downstream failures. + +## Parameters + +### code + +`Code` + +The gRPC status code for the error. + +### message? + +`string` + +Human-readable error message. Defaults to `"Mock error"`. + +## Returns + +`any` + +A spy-enabled async function that throws on every call. + +## Example + +```ts +import { Code } from "@connectrpc/connect"; +import { createMockNextError } from "@connectum/testing"; + +const next = createMockNextError(Code.NotFound, "user not found"); +await next({}).catch((err) => { + // err instanceof ConnectError => true + // err.code => Code.NotFound +}); +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md b/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md new file mode 100644 index 0000000..04ae165 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockNextSlow.md @@ -0,0 +1,41 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockNextSlow + +# Function: createMockNextSlow() + +> **createMockNextSlow**(`delay`, `options?`): `any` + +Defined in: mock-next.ts:93 + +Create a mock `next` handler that resolves after a configurable delay. + +Useful for testing timeout interceptors and other time-sensitive logic. + +## Parameters + +### delay + +`number` + +Time to wait in milliseconds before resolving. + +### options? + +[`MockNextOptions`](../../types/interfaces/MockNextOptions.md) + +Optional overrides for the response payload and stream flag. + +## Returns + +`any` + +A spy-enabled async function that sleeps before returning a response. + +## Example + +```ts +import { createMockNextSlow } from "@connectum/testing"; + +const next = createMockNextSlow(500); +const res = await next({}); // resolves after ~500 ms +// res.message => { result: "success" } +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md b/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md new file mode 100644 index 0000000..e27ddcf --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockRequest.md @@ -0,0 +1,39 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockRequest + +# Function: createMockRequest() + +> **createMockRequest**(`options?`): `any` + +Defined in: mock-request.ts:34 + +Create a mock ConnectRPC [UnaryRequest](https://connectrpc.com/docs/node/interceptors) +object suitable for testing interceptors. + +All fields have sensible defaults, so calling `createMockRequest()` with no +arguments returns a fully valid request that can be passed straight into an +interceptor under test. + +## Parameters + +### options? + +[`MockRequestOptions`](../../types/interfaces/MockRequestOptions.md) + +Optional overrides for request fields. + +## Returns + +`any` + +A plain object matching the ConnectRPC `UnaryRequest` shape. + +## Example + +```ts +import { createMockRequest } from "@connectum/testing"; + +const req = createMockRequest({ service: "acme.UserService", method: "GetUser" }); +// req.service.typeName === "acme.UserService" +// req.method.name === "GetUser" +// req.url === "http://localhost/acme.UserService/GetUser" +``` diff --git a/en/api/@connectum/test-fixtures/index/functions/createMockStream.md b/en/api/@connectum/test-fixtures/index/functions/createMockStream.md new file mode 100644 index 0000000..fdaee45 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/functions/createMockStream.md @@ -0,0 +1,55 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / createMockStream + +# Function: createMockStream() + +> **createMockStream**\<`T`\>(`items`, `options?`): `AsyncIterable`\<`T`\> + +Defined in: mock-stream.ts:35 + +Create an AsyncIterable that yields `items` sequentially. + +Useful for testing ConnectRPC server-streaming or client-streaming +interceptors and handlers without a real gRPC connection. + +The returned iterable is **reusable** — each call to +`Symbol.asyncIterator` starts a fresh iteration over the same items. + +## Type Parameters + +### T + +`T` + +Type of items yielded by the stream. + +## Parameters + +### items + +`T`[] + +Array of items to yield in order. + +### options? + +[`MockStreamOptions`](../../types/interfaces/MockStreamOptions.md) + +Optional stream behavior configuration. + +## Returns + +`AsyncIterable`\<`T`\> + +An async iterable that yields each item from `items`. + +## Example + +```ts +import { createMockStream } from "@connectum/testing"; + +const stream = createMockStream([1, 2, 3], { delayMs: 10 }); + +for await (const value of stream) { + console.log(value); // 1, 2, 3 +} +``` diff --git a/en/api/@connectum/test-fixtures/index/index.md b/en/api/@connectum/test-fixtures/index/index.md new file mode 100644 index 0000000..4dc3b83 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/index.md @@ -0,0 +1,76 @@ +[Connectum API Reference](../../../index.md) / [@connectum/test-fixtures](../index.md) / index + +# index + +@connectum/test-fixtures — Mock factories and assertion helpers for Connectum tests. + +Transport-free (no `@connectum/core` dependency) so every Connectum package +can depend on it without creating workspace build cycles. + +## Interfaces + +- [MockCall](interfaces/MockCall.md) +- [MockFn](interfaces/MockFn.md) + +## Functions + +- [assertConnectError](functions/assertConnectError.md) +- [createFakeMethod](functions/createFakeMethod.md) +- [createFakeService](functions/createFakeService.md) +- [createMockDescField](functions/createMockDescField.md) +- [createMockDescMessage](functions/createMockDescMessage.md) +- [createMockDescMethod](functions/createMockDescMethod.md) +- [createMockFn](functions/createMockFn.md) +- [createMockNext](functions/createMockNext.md) +- [createMockNextError](functions/createMockNextError.md) +- [createMockNextSlow](functions/createMockNextSlow.md) +- [createMockRequest](functions/createMockRequest.md) +- [createMockStream](functions/createMockStream.md) + +## References + +### FakeMethodOptions + +Re-exports [FakeMethodOptions](../types/interfaces/FakeMethodOptions.md) + +*** + +### FakeServiceOptions + +Re-exports [FakeServiceOptions](../types/interfaces/FakeServiceOptions.md) + +*** + +### MockDescFieldOptions + +Re-exports [MockDescFieldOptions](../types/interfaces/MockDescFieldOptions.md) + +*** + +### MockDescMessageOptions + +Re-exports [MockDescMessageOptions](../types/interfaces/MockDescMessageOptions.md) + +*** + +### MockDescMethodOptions + +Re-exports [MockDescMethodOptions](../types/interfaces/MockDescMethodOptions.md) + +*** + +### MockNextOptions + +Re-exports [MockNextOptions](../types/interfaces/MockNextOptions.md) + +*** + +### MockRequestOptions + +Re-exports [MockRequestOptions](../types/interfaces/MockRequestOptions.md) + +*** + +### MockStreamOptions + +Re-exports [MockStreamOptions](../types/interfaces/MockStreamOptions.md) diff --git a/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md b/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md new file mode 100644 index 0000000..6e5412e --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/interfaces/MockCall.md @@ -0,0 +1,23 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / MockCall + +# Interface: MockCall\ + +Defined in: mock-compat.ts:15 + +A single recorded invocation of a [MockFn](MockFn.md). + +## Type Parameters + +### Args + +`Args` *extends* readonly `unknown`[] = readonly `unknown`[] + +## Properties + +### arguments + +> `readonly` **arguments**: `Args` + +Defined in: mock-compat.ts:17 + +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 new file mode 100644 index 0000000..21c2461 --- /dev/null +++ b/en/api/@connectum/test-fixtures/index/interfaces/MockFn.md @@ -0,0 +1,61 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [index](../index.md) / MockFn + +# Interface: MockFn()\ + +Defined in: mock-compat.ts:27 + +A callable spy that records every invocation. + +The shape intentionally mirrors the subset of `node:test` `mock.fn()` +that Connectum testing utilities rely on. + +## Type Parameters + +### F + +`F` *extends* (...`args`) => `any` + +> **MockFn**(...`args`): `ReturnType`\<`F`\> + +Defined in: mock-compat.ts:28 + +A callable spy that records every invocation. + +The shape intentionally mirrors the subset of `node:test` `mock.fn()` +that Connectum testing utilities rely on. + +## Parameters + +### args + +...`Parameters`\<`F`\> + +## Returns + +`ReturnType`\<`F`\> + +## Properties + +### mock + +> `readonly` **mock**: `object` + +Defined in: mock-compat.ts:30 + +Spy metadata. + +#### calls + +> `readonly` **calls**: readonly [`MockCall`](MockCall.md)\<`Parameters`\<`F`\>\>[] + +Ordered list of recorded calls. + +#### callCount() + +> **callCount**(): `number` + +Returns the total number of recorded calls. + +##### Returns + +`number` diff --git a/en/api/@connectum/test-fixtures/types/index.md b/en/api/@connectum/test-fixtures/types/index.md new file mode 100644 index 0000000..e0305d1 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/index.md @@ -0,0 +1,16 @@ +[Connectum API Reference](../../../index.md) / [@connectum/test-fixtures](../index.md) / types + +# types + +Type definitions for @connectum/test-fixtures. + +## Interfaces + +- [FakeMethodOptions](interfaces/FakeMethodOptions.md) +- [FakeServiceOptions](interfaces/FakeServiceOptions.md) +- [MockDescFieldOptions](interfaces/MockDescFieldOptions.md) +- [MockDescMessageOptions](interfaces/MockDescMessageOptions.md) +- [MockDescMethodOptions](interfaces/MockDescMethodOptions.md) +- [MockNextOptions](interfaces/MockNextOptions.md) +- [MockRequestOptions](interfaces/MockRequestOptions.md) +- [MockStreamOptions](interfaces/MockStreamOptions.md) diff --git a/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md b/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md new file mode 100644 index 0000000..0e8d8d2 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/FakeMethodOptions.md @@ -0,0 +1,27 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / FakeMethodOptions + +# Interface: FakeMethodOptions + +Defined in: types.ts:102 + +Options for createFakeMethod. + +## Properties + +### methodKind? + +> `optional` **methodKind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` + +Defined in: types.ts:104 + +Method kind. Default: `'unary'` + +*** + +### register? + +> `optional` **register?**: `boolean` + +Defined in: types.ts:106 + +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 new file mode 100644 index 0000000..3fd40fd --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/FakeServiceOptions.md @@ -0,0 +1,27 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / FakeServiceOptions + +# Interface: FakeServiceOptions + +Defined in: types.ts:94 + +Options for createFakeService. + +## Properties + +### name? + +> `optional` **name?**: `string` + +Defined in: types.ts:98 + +Service name (short). Default: derived from typeName + +*** + +### typeName? + +> `optional` **typeName?**: `string` + +Defined in: types.ts:96 + +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 new file mode 100644 index 0000000..f992412 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockDescFieldOptions.md @@ -0,0 +1,37 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / MockDescFieldOptions + +# Interface: MockDescFieldOptions + +Defined in: types.ts:58 + +Options for createMockDescField. + +## Properties + +### fieldNumber? + +> `optional` **fieldNumber?**: `number` + +Defined in: types.ts:62 + +Proto field number. Default: auto-incremented + +*** + +### isSensitive? + +> `optional` **isSensitive?**: `boolean` + +Defined in: types.ts:60 + +Mark field as sensitive (for redact interceptor). Default: `false` + +*** + +### type? + +> `optional` **type?**: `string` + +Defined in: types.ts:64 + +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 new file mode 100644 index 0000000..b375547 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockDescMessageOptions.md @@ -0,0 +1,39 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / MockDescMessageOptions + +# Interface: MockDescMessageOptions + +Defined in: types.ts:46 + +Options for createMockDescMessage. + +## Properties + +### fields? + +> `optional` **fields?**: `object`[] + +Defined in: types.ts:48 + +Field definitions. Default: `[]` + +#### fieldNumber? + +> `optional` **fieldNumber?**: `number` + +#### name + +> **name**: `string` + +#### type? + +> `optional` **type?**: `string` + +*** + +### oneofs? + +> `optional` **oneofs?**: `string`[] + +Defined in: types.ts:54 + +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 new file mode 100644 index 0000000..a59e2df --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockDescMethodOptions.md @@ -0,0 +1,47 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / MockDescMethodOptions + +# Interface: MockDescMethodOptions + +Defined in: types.ts:68 + +Options for createMockDescMethod. + +## Properties + +### input? + +> `optional` **input?**: `DescMessage` + +Defined in: types.ts:70 + +Input message descriptor. + +*** + +### kind? + +> `optional` **kind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` + +Defined in: types.ts:74 + +Method kind. Default: `'unary'` + +*** + +### output? + +> `optional` **output?**: `DescMessage` + +Defined in: types.ts:72 + +Output message descriptor. + +*** + +### useSensitiveRedaction? + +> `optional` **useSensitiveRedaction?**: `boolean` + +Defined in: types.ts:76 + +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 new file mode 100644 index 0000000..12cb881 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockNextOptions.md @@ -0,0 +1,27 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / MockNextOptions + +# Interface: MockNextOptions + +Defined in: types.ts:34 + +Options for createMockNext and createMockNextSlow. + +## Properties + +### message? + +> `optional` **message?**: `unknown` + +Defined in: types.ts:36 + +Response message. Default: `{ result: 'success' }` + +*** + +### stream? + +> `optional` **stream?**: `boolean` + +Defined in: types.ts:38 + +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 new file mode 100644 index 0000000..21b44b1 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockRequestOptions.md @@ -0,0 +1,67 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / MockRequestOptions + +# Interface: MockRequestOptions + +Defined in: types.ts:14 + +Options for createMockRequest. + +## Properties + +### headers? + +> `optional` **headers?**: `Headers` + +Defined in: types.ts:26 + +Request headers. Default: `new Headers()` + +*** + +### message? + +> `optional` **message?**: `unknown` + +Defined in: types.ts:20 + +Request message payload. Default: `{}` + +*** + +### method? + +> `optional` **method?**: `string` + +Defined in: types.ts:18 + +Method name. Default: `'TestMethod'` + +*** + +### service? + +> `optional` **service?**: `string` + +Defined in: types.ts:16 + +Service type name. Default: `'test.TestService'` + +*** + +### stream? + +> `optional` **stream?**: `boolean` + +Defined in: types.ts:22 + +Streaming request flag. Default: `false` + +*** + +### url? + +> `optional` **url?**: `string` + +Defined in: types.ts:24 + +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 new file mode 100644 index 0000000..4ce0ca6 --- /dev/null +++ b/en/api/@connectum/test-fixtures/types/interfaces/MockStreamOptions.md @@ -0,0 +1,17 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/test-fixtures](../../index.md) / [types](../index.md) / MockStreamOptions + +# Interface: MockStreamOptions + +Defined in: types.ts:84 + +Options for createMockStream. + +## Properties + +### delayMs? + +> `optional` **delayMs?**: `number` + +Defined in: types.ts:86 + +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 new file mode 100644 index 0000000..6c6d330 --- /dev/null +++ b/en/api/@connectum/testing/index/classes/InMemoryMetricCollector.md @@ -0,0 +1,81 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / InMemoryMetricCollector + +# Class: InMemoryMetricCollector + +Defined in: testing/src/otel-collectors.ts:141 + +In-memory metric collector. Owns its own `MeterProvider` and periodic +reader. `flush()` performs a forced collect+export cycle synchronously +(via `forceFlush`) and returns the normalized data. + +## Constructors + +### Constructor + +> **new InMemoryMetricCollector**(): `InMemoryMetricCollector` + +Defined in: testing/src/otel-collectors.ts:146 + +#### Returns + +`InMemoryMetricCollector` + +## Properties + +### exporter + +> `readonly` **exporter**: `InMemoryMetricExporter` + +Defined in: testing/src/otel-collectors.ts:142 + +*** + +### provider + +> `readonly` **provider**: `MeterProvider` + +Defined in: testing/src/otel-collectors.ts:143 + +*** + +### reader + +> `readonly` **reader**: `PeriodicExportingMetricReader` + +Defined in: testing/src/otel-collectors.ts:144 + +## Methods + +### dispose() + +> **dispose**(): `Promise`\<`void`\> + +Defined in: testing/src/otel-collectors.ts:176 + +#### Returns + +`Promise`\<`void`\> + +*** + +### flush() + +> **flush**(): `Promise`\<[`NormalizedMetric`](../interfaces/NormalizedMetric.md)[]\> + +Defined in: testing/src/otel-collectors.ts:158 + +#### Returns + +`Promise`\<[`NormalizedMetric`](../interfaces/NormalizedMetric.md)[]\> + +*** + +### reset() + +> **reset**(): `void` + +Defined in: testing/src/otel-collectors.ts:172 + +#### Returns + +`void` diff --git a/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md b/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md new file mode 100644 index 0000000..70f130c --- /dev/null +++ b/en/api/@connectum/testing/index/classes/InMemorySpanCollector.md @@ -0,0 +1,80 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / InMemorySpanCollector + +# Class: InMemorySpanCollector + +Defined in: testing/src/otel-collectors.ts:110 + +In-memory span collector. Owns its own `BasicTracerProvider` so that +different scenarios cannot cross-contaminate. + +Callers wishing to register the provider globally (so that +`trace.getTracer(...)` resolves here) should call registerGlobal +— and pair it with [InMemorySpanCollector.dispose](#dispose) when done. + +## Constructors + +### Constructor + +> **new InMemorySpanCollector**(): `InMemorySpanCollector` + +Defined in: testing/src/otel-collectors.ts:114 + +#### Returns + +`InMemorySpanCollector` + +## Properties + +### exporter + +> `readonly` **exporter**: `InMemorySpanExporter` + +Defined in: testing/src/otel-collectors.ts:111 + +*** + +### provider + +> `readonly` **provider**: `BasicTracerProvider` + +Defined in: testing/src/otel-collectors.ts:112 + +## Methods + +### dispose() + +> **dispose**(): `Promise`\<`void`\> + +Defined in: testing/src/otel-collectors.ts:131 + +#### Returns + +`Promise`\<`void`\> + +*** + +### flush() + +> **flush**(): [`NormalizedSpan`](../interfaces/NormalizedSpan.md)[] + +Defined in: testing/src/otel-collectors.ts:122 + +Returns normalized finished spans collected so far. + +#### Returns + +[`NormalizedSpan`](../interfaces/NormalizedSpan.md)[] + +*** + +### reset() + +> **reset**(): `void` + +Defined in: testing/src/otel-collectors.ts:127 + +Clear the internal buffer. + +#### Returns + +`void` diff --git a/en/api/@connectum/testing/index/functions/assertConnectError.md b/en/api/@connectum/testing/index/functions/assertConnectError.md index cca09c8..b72c317 100644 --- a/en/api/@connectum/testing/index/functions/assertConnectError.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/assertions.ts#L44) +Defined in: test-fixtures/dist/index.d.ts:44 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/testing/index/functions/createFakeMethod.md b/en/api/@connectum/testing/index/functions/createFakeMethod.md index e63fd4b..a085865 100644 --- a/en/api/@connectum/testing/index/functions/createFakeMethod.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/fake-service.ts#L72) +Defined in: test-fixtures/dist/index.d.ts:100 Create a fake DescMethod descriptor attached to a service. @@ -29,7 +29,7 @@ The RPC method name (PascalCase, e.g. `"GetUser"`). ### options? -[`FakeMethodOptions`](../../types/interfaces/FakeMethodOptions.md) +[`FakeMethodOptions`](../interfaces/FakeMethodOptions.md) Optional configuration for method kind and registration. diff --git a/en/api/@connectum/testing/index/functions/createFakeService.md b/en/api/@connectum/testing/index/functions/createFakeService.md index d3ddd55..8be42a8 100644 --- a/en/api/@connectum/testing/index/functions/createFakeService.md +++ b/en/api/@connectum/testing/index/functions/createFakeService.md @@ -4,7 +4,7 @@ > **createFakeService**(`options?`): `DescService` -Defined in: [fake-service.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/fake-service.ts#L34) +Defined in: test-fixtures/dist/index.d.ts:76 Create a fake DescService descriptor for testing. @@ -17,7 +17,7 @@ start empty; use [createFakeMethod](createFakeMethod.md) with `register: true` t ### options? -[`FakeServiceOptions`](../../types/interfaces/FakeServiceOptions.md) +[`FakeServiceOptions`](../interfaces/FakeServiceOptions.md) Optional overrides for service name and typeName. diff --git a/en/api/@connectum/testing/index/functions/createLocalClient.md b/en/api/@connectum/testing/index/functions/createLocalClient.md new file mode 100644 index 0000000..66077ec --- /dev/null +++ b/en/api/@connectum/testing/index/functions/createLocalClient.md @@ -0,0 +1,46 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / createLocalClient + +# Function: createLocalClient() + +> **createLocalClient**\<`T`\>(`server`, `service`): `Client`\<`T`\> + +Defined in: testing/src/createLocalClient.ts:38 + +Create an in-process ConnectRPC client for a service registered on the given Server. + +## Type Parameters + +### T + +`T` *extends* `DescService` + +## Parameters + +### server + +`Server` + +A server created via `createServer({...})`. Does not need to be started. + +### service + +`T` + +The proto service descriptor (e.g. `GreeterService`). + +## Returns + +`Client`\<`T`\> + +A typed ConnectRPC `Client` that invokes handlers via the in-memory pipe. + +## Example + +```typescript +import { createServer } from "@connectum/core"; +import { createLocalClient } from "@connectum/testing"; + +const server = createServer({ services: [greeterRoutes] }); +const client = createLocalClient(server, GreeterService); +const res = await client.sayHello({ name: "world" }); +``` diff --git a/en/api/@connectum/testing/index/functions/createMockDescField.md b/en/api/@connectum/testing/index/functions/createMockDescField.md index 4cb3ab7..f360cd8 100644 --- a/en/api/@connectum/testing/index/functions/createMockDescField.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-desc.ts#L62) +Defined in: test-fixtures/dist/index.d.ts:182 Create a mock DescField descriptor. @@ -21,7 +21,7 @@ The field's local (camelCase) name. ### options? -[`MockDescFieldOptions`](../../types/interfaces/MockDescFieldOptions.md) +[`MockDescFieldOptions`](../interfaces/MockDescFieldOptions.md) Optional overrides for field number, scalar type, and sensitivity. diff --git a/en/api/@connectum/testing/index/functions/createMockDescMessage.md b/en/api/@connectum/testing/index/functions/createMockDescMessage.md index 5f120ea..5ae9b28 100644 --- a/en/api/@connectum/testing/index/functions/createMockDescMessage.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-desc.ts#L109) +Defined in: test-fixtures/dist/index.d.ts:210 Create a mock DescMessage descriptor with all required structural properties. @@ -23,7 +23,7 @@ Fully-qualified protobuf type name (e.g. `"acme.v1.User"`). ### options? -[`MockDescMessageOptions`](../../types/interfaces/MockDescMessageOptions.md) +[`MockDescMessageOptions`](../interfaces/MockDescMessageOptions.md) Optional field and oneof definitions. diff --git a/en/api/@connectum/testing/index/functions/createMockDescMethod.md b/en/api/@connectum/testing/index/functions/createMockDescMethod.md index 1892bb6..7e42e86 100644 --- a/en/api/@connectum/testing/index/functions/createMockDescMethod.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-desc.ts#L172) +Defined in: test-fixtures/dist/index.d.ts:236 Create a mock DescMethod descriptor. @@ -22,7 +22,7 @@ The RPC method name (PascalCase by convention). ### options? -[`MockDescMethodOptions`](../../types/interfaces/MockDescMethodOptions.md) +[`MockDescMethodOptions`](../interfaces/MockDescMethodOptions.md) Optional overrides for kind, input/output, and redaction. diff --git a/en/api/@connectum/testing/index/functions/createMockFn.md b/en/api/@connectum/testing/index/functions/createMockFn.md index aea3da8..a5026bb 100644 --- a/en/api/@connectum/testing/index/functions/createMockFn.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L54) +Defined in: test-fixtures/dist/index.d.ts:150 Create a portable mock function that wraps `impl` and records every call. diff --git a/en/api/@connectum/testing/index/functions/createMockNext.md b/en/api/@connectum/testing/index/functions/createMockNext.md index cda27eb..9ccfe6d 100644 --- a/en/api/@connectum/testing/index/functions/createMockNext.md +++ b/en/api/@connectum/testing/index/functions/createMockNext.md @@ -4,7 +4,7 @@ > **createMockNext**(`options?`): `any` -Defined in: [mock-next.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-next.ts#L36) +Defined in: test-fixtures/dist/index.d.ts:267 Create a mock `next` handler that resolves with a successful response. @@ -15,7 +15,7 @@ inspect `next.mock.calls` and `next.mock.callCount()` after the test. ### options? -[`MockNextOptions`](../../types/interfaces/MockNextOptions.md) +[`MockNextOptions`](../interfaces/MockNextOptions.md) Optional overrides for the response payload and stream flag. diff --git a/en/api/@connectum/testing/index/functions/createMockNextError.md b/en/api/@connectum/testing/index/functions/createMockNextError.md index 3cc9a70..c64671d 100644 --- a/en/api/@connectum/testing/index/functions/createMockNextError.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-next.ts#L68) +Defined in: test-fixtures/dist/index.d.ts:289 Create a mock `next` handler that always throws a ConnectError. diff --git a/en/api/@connectum/testing/index/functions/createMockNextSlow.md b/en/api/@connectum/testing/index/functions/createMockNextSlow.md index 2d3032e..9890f10 100644 --- a/en/api/@connectum/testing/index/functions/createMockNextSlow.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-next.ts#L93) +Defined in: test-fixtures/dist/index.d.ts:308 Create a mock `next` handler that resolves after a configurable delay. @@ -20,7 +20,7 @@ Time to wait in milliseconds before resolving. ### options? -[`MockNextOptions`](../../types/interfaces/MockNextOptions.md) +[`MockNextOptions`](../interfaces/MockNextOptions.md) Optional overrides for the response payload and stream flag. diff --git a/en/api/@connectum/testing/index/functions/createMockRequest.md b/en/api/@connectum/testing/index/functions/createMockRequest.md index 8690571..6d58c81 100644 --- a/en/api/@connectum/testing/index/functions/createMockRequest.md +++ b/en/api/@connectum/testing/index/functions/createMockRequest.md @@ -4,7 +4,7 @@ > **createMockRequest**(`options?`): `any` -Defined in: [mock-request.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-request.ts#L34) +Defined in: test-fixtures/dist/index.d.ts:337 Create a mock ConnectRPC [UnaryRequest](https://connectrpc.com/docs/node/interceptors) object suitable for testing interceptors. @@ -17,7 +17,7 @@ interceptor under test. ### options? -[`MockRequestOptions`](../../types/interfaces/MockRequestOptions.md) +[`MockRequestOptions`](../interfaces/MockRequestOptions.md) Optional overrides for request fields. diff --git a/en/api/@connectum/testing/index/functions/createMockStream.md b/en/api/@connectum/testing/index/functions/createMockStream.md index cd3b3b3..4e89f2e 100644 --- a/en/api/@connectum/testing/index/functions/createMockStream.md +++ b/en/api/@connectum/testing/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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-stream.ts#L35) +Defined in: test-fixtures/dist/index.d.ts:370 Create an AsyncIterable that yields `items` sequentially. @@ -32,7 +32,7 @@ Array of items to yield in order. ### options? -[`MockStreamOptions`](../../types/interfaces/MockStreamOptions.md) +[`MockStreamOptions`](../interfaces/MockStreamOptions.md) Optional stream behavior configuration. diff --git a/en/api/@connectum/testing/index/functions/createTestServer.md b/en/api/@connectum/testing/index/functions/createTestServer.md index d680117..3560678 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: [test-server.ts:33](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/test-server.ts#L33) +Defined in: [testing/src/test-server.ts:33](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/withTestServer.md b/en/api/@connectum/testing/index/functions/withTestServer.md index 1b72617..9daa76f 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: [test-server.ts:93](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/test-server.ts#L93) +Defined in: [testing/src/test-server.ts:93](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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/index.md b/en/api/@connectum/testing/index/index.md index b3a7703..dff2cfa 100644 --- a/en/api/@connectum/testing/index/index.md +++ b/en/api/@connectum/testing/index/index.md @@ -4,19 +4,46 @@ @connectum/testing — Testing utilities for the Connectum framework. -Provides mock factories, assertion helpers, and a test server utility -to eliminate boilerplate in ConnectRPC interceptor and service tests. +Provides a test server utility, in-process transport helpers, OTel +collectors, and a cross-transport parity driver to eliminate boilerplate +in ConnectRPC service tests. + +Mock factories, assertion helpers and protobuf descriptor fixtures now +live in `@connectum/test-fixtures`. They are re-exported from this entry +for backwards compatibility — existing imports from `@connectum/testing` +continue to work unchanged. + +## Classes + +- [InMemoryMetricCollector](classes/InMemoryMetricCollector.md) +- [InMemorySpanCollector](classes/InMemorySpanCollector.md) ## Interfaces +- [FakeMethodOptions](interfaces/FakeMethodOptions.md) +- [FakeServiceOptions](interfaces/FakeServiceOptions.md) - [MockCall](interfaces/MockCall.md) +- [MockDescFieldOptions](interfaces/MockDescFieldOptions.md) +- [MockDescMessageOptions](interfaces/MockDescMessageOptions.md) +- [MockDescMethodOptions](interfaces/MockDescMethodOptions.md) - [MockFn](interfaces/MockFn.md) +- [MockNextOptions](interfaces/MockNextOptions.md) +- [MockRequestOptions](interfaces/MockRequestOptions.md) +- [MockStreamOptions](interfaces/MockStreamOptions.md) +- [NormalizedMetric](interfaces/NormalizedMetric.md) +- [NormalizedSpan](interfaces/NormalizedSpan.md) + +## Variables + +- [TRANSPORT\_METRIC\_ATTRIBUTE](variables/TRANSPORT_METRIC_ATTRIBUTE.md) +- [TRANSPORT\_SPAN\_ATTRIBUTE](variables/TRANSPORT_SPAN_ATTRIBUTE.md) ## Functions - [assertConnectError](functions/assertConnectError.md) - [createFakeMethod](functions/createFakeMethod.md) - [createFakeService](functions/createFakeService.md) +- [createLocalClient](functions/createLocalClient.md) - [createMockDescField](functions/createMockDescField.md) - [createMockDescMessage](functions/createMockDescMessage.md) - [createMockDescMethod](functions/createMockDescMethod.md) @@ -37,54 +64,6 @@ Re-exports [CreateTestServerOptions](../types/interfaces/CreateTestServerOptions *** -### FakeMethodOptions - -Re-exports [FakeMethodOptions](../types/interfaces/FakeMethodOptions.md) - -*** - -### FakeServiceOptions - -Re-exports [FakeServiceOptions](../types/interfaces/FakeServiceOptions.md) - -*** - -### MockDescFieldOptions - -Re-exports [MockDescFieldOptions](../types/interfaces/MockDescFieldOptions.md) - -*** - -### MockDescMessageOptions - -Re-exports [MockDescMessageOptions](../types/interfaces/MockDescMessageOptions.md) - -*** - -### MockDescMethodOptions - -Re-exports [MockDescMethodOptions](../types/interfaces/MockDescMethodOptions.md) - -*** - -### MockNextOptions - -Re-exports [MockNextOptions](../types/interfaces/MockNextOptions.md) - -*** - -### MockRequestOptions - -Re-exports [MockRequestOptions](../types/interfaces/MockRequestOptions.md) - -*** - -### MockStreamOptions - -Re-exports [MockStreamOptions](../types/interfaces/MockStreamOptions.md) - -*** - ### TestServer Re-exports [TestServer](../types/interfaces/TestServer.md) diff --git a/en/api/@connectum/testing/index/interfaces/FakeMethodOptions.md b/en/api/@connectum/testing/index/interfaces/FakeMethodOptions.md new file mode 100644 index 0000000..53d7a23 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/FakeMethodOptions.md @@ -0,0 +1,27 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / FakeMethodOptions + +# Interface: FakeMethodOptions + +Defined in: test-fixtures/dist/types.d.ts:75 + +Options for [createFakeMethod](../functions/createFakeMethod.md). + +## Properties + +### methodKind? + +> `optional` **methodKind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` + +Defined in: test-fixtures/dist/types.d.ts:77 + +Method kind. Default: `'unary'` + +*** + +### register? + +> `optional` **register?**: `boolean` + +Defined in: test-fixtures/dist/types.d.ts:79 + +Whether to register the method in service.methods. Default: `false` diff --git a/en/api/@connectum/testing/index/interfaces/FakeServiceOptions.md b/en/api/@connectum/testing/index/interfaces/FakeServiceOptions.md new file mode 100644 index 0000000..732d6d3 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/FakeServiceOptions.md @@ -0,0 +1,27 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / FakeServiceOptions + +# Interface: FakeServiceOptions + +Defined in: test-fixtures/dist/types.d.ts:68 + +Options for [createFakeService](../functions/createFakeService.md). + +## Properties + +### name? + +> `optional` **name?**: `string` + +Defined in: test-fixtures/dist/types.d.ts:72 + +Service name (short). Default: derived from typeName + +*** + +### typeName? + +> `optional` **typeName?**: `string` + +Defined in: test-fixtures/dist/types.d.ts:70 + +Service type name. Default: `'test.v1.TestService'` diff --git a/en/api/@connectum/testing/index/interfaces/MockCall.md b/en/api/@connectum/testing/index/interfaces/MockCall.md index 3b3d6ff..d2d0268 100644 --- a/en/api/@connectum/testing/index/interfaces/MockCall.md +++ b/en/api/@connectum/testing/index/interfaces/MockCall.md @@ -2,7 +2,7 @@ # Interface: MockCall\ -Defined in: [mock-compat.ts:15](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L15) +Defined in: test-fixtures/dist/index.d.ts:115 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L17) +Defined in: test-fixtures/dist/index.d.ts:117 The arguments passed to the mock function. diff --git a/en/api/@connectum/testing/index/interfaces/MockDescFieldOptions.md b/en/api/@connectum/testing/index/interfaces/MockDescFieldOptions.md new file mode 100644 index 0000000..d1aea44 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/MockDescFieldOptions.md @@ -0,0 +1,37 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / MockDescFieldOptions + +# Interface: MockDescFieldOptions + +Defined in: test-fixtures/dist/types.d.ts:43 + +Options for [createMockDescField](../functions/createMockDescField.md). + +## Properties + +### fieldNumber? + +> `optional` **fieldNumber?**: `number` + +Defined in: test-fixtures/dist/types.d.ts:47 + +Proto field number. Default: auto-incremented + +*** + +### isSensitive? + +> `optional` **isSensitive?**: `boolean` + +Defined in: test-fixtures/dist/types.d.ts:45 + +Mark field as sensitive (for redact interceptor). Default: `false` + +*** + +### type? + +> `optional` **type?**: `string` + +Defined in: test-fixtures/dist/types.d.ts:49 + +Field scalar type. Default: `'string'` diff --git a/en/api/@connectum/testing/index/interfaces/MockDescMessageOptions.md b/en/api/@connectum/testing/index/interfaces/MockDescMessageOptions.md new file mode 100644 index 0000000..100b0f0 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/MockDescMessageOptions.md @@ -0,0 +1,39 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / MockDescMessageOptions + +# Interface: MockDescMessageOptions + +Defined in: test-fixtures/dist/types.d.ts:32 + +Options for [createMockDescMessage](../functions/createMockDescMessage.md). + +## Properties + +### fields? + +> `optional` **fields?**: `object`[] + +Defined in: test-fixtures/dist/types.d.ts:34 + +Field definitions. Default: `[]` + +#### fieldNumber? + +> `optional` **fieldNumber?**: `number` + +#### name + +> **name**: `string` + +#### type? + +> `optional` **type?**: `string` + +*** + +### oneofs? + +> `optional` **oneofs?**: `string`[] + +Defined in: test-fixtures/dist/types.d.ts:40 + +Oneof group names. Default: `[]` diff --git a/en/api/@connectum/testing/index/interfaces/MockDescMethodOptions.md b/en/api/@connectum/testing/index/interfaces/MockDescMethodOptions.md new file mode 100644 index 0000000..2606b17 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/MockDescMethodOptions.md @@ -0,0 +1,47 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / MockDescMethodOptions + +# Interface: MockDescMethodOptions + +Defined in: test-fixtures/dist/types.d.ts:52 + +Options for [createMockDescMethod](../functions/createMockDescMethod.md). + +## Properties + +### input? + +> `optional` **input?**: `DescMessage` + +Defined in: test-fixtures/dist/types.d.ts:54 + +Input message descriptor. + +*** + +### kind? + +> `optional` **kind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` + +Defined in: test-fixtures/dist/types.d.ts:58 + +Method kind. Default: `'unary'` + +*** + +### output? + +> `optional` **output?**: `DescMessage` + +Defined in: test-fixtures/dist/types.d.ts:56 + +Output message descriptor. + +*** + +### useSensitiveRedaction? + +> `optional` **useSensitiveRedaction?**: `boolean` + +Defined in: test-fixtures/dist/types.d.ts:60 + +Enable sensitive field redaction for this method. Default: `false` diff --git a/en/api/@connectum/testing/index/interfaces/MockFn.md b/en/api/@connectum/testing/index/interfaces/MockFn.md index 3f88c37..a9fe93f 100644 --- a/en/api/@connectum/testing/index/interfaces/MockFn.md +++ b/en/api/@connectum/testing/index/interfaces/MockFn.md @@ -2,7 +2,7 @@ # Interface: MockFn()\ -Defined in: [mock-compat.ts:27](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L27) +Defined in: test-fixtures/dist/index.d.ts:125 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L28) +Defined in: test-fixtures/dist/index.d.ts:126 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/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/mock-compat.ts#L30) +Defined in: test-fixtures/dist/index.d.ts:128 Spy metadata. diff --git a/en/api/@connectum/testing/index/interfaces/MockNextOptions.md b/en/api/@connectum/testing/index/interfaces/MockNextOptions.md new file mode 100644 index 0000000..801f9b9 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/MockNextOptions.md @@ -0,0 +1,27 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / MockNextOptions + +# Interface: MockNextOptions + +Defined in: test-fixtures/dist/types.d.ts:25 + +Options for [createMockNext](../functions/createMockNext.md) and [createMockNextSlow](../functions/createMockNextSlow.md). + +## Properties + +### message? + +> `optional` **message?**: `unknown` + +Defined in: test-fixtures/dist/types.d.ts:27 + +Response message. Default: `{ result: 'success' }` + +*** + +### stream? + +> `optional` **stream?**: `boolean` + +Defined in: test-fixtures/dist/types.d.ts:29 + +Streaming response flag. Default: `false` diff --git a/en/api/@connectum/testing/index/interfaces/MockRequestOptions.md b/en/api/@connectum/testing/index/interfaces/MockRequestOptions.md new file mode 100644 index 0000000..a215ee2 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/MockRequestOptions.md @@ -0,0 +1,67 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / MockRequestOptions + +# Interface: MockRequestOptions + +Defined in: test-fixtures/dist/types.d.ts:10 + +Options for [createMockRequest](../functions/createMockRequest.md). + +## Properties + +### headers? + +> `optional` **headers?**: `Headers` + +Defined in: test-fixtures/dist/types.d.ts:22 + +Request headers. Default: `new Headers()` + +*** + +### message? + +> `optional` **message?**: `unknown` + +Defined in: test-fixtures/dist/types.d.ts:16 + +Request message payload. Default: `{}` + +*** + +### method? + +> `optional` **method?**: `string` + +Defined in: test-fixtures/dist/types.d.ts:14 + +Method name. Default: `'TestMethod'` + +*** + +### service? + +> `optional` **service?**: `string` + +Defined in: test-fixtures/dist/types.d.ts:12 + +Service type name. Default: `'test.TestService'` + +*** + +### stream? + +> `optional` **stream?**: `boolean` + +Defined in: test-fixtures/dist/types.d.ts:18 + +Streaming request flag. Default: `false` + +*** + +### url? + +> `optional` **url?**: `string` + +Defined in: test-fixtures/dist/types.d.ts:20 + +Request URL. Auto-generated from service/method if omitted. diff --git a/en/api/@connectum/testing/index/interfaces/MockStreamOptions.md b/en/api/@connectum/testing/index/interfaces/MockStreamOptions.md new file mode 100644 index 0000000..2c56c10 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/MockStreamOptions.md @@ -0,0 +1,17 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / MockStreamOptions + +# Interface: MockStreamOptions + +Defined in: test-fixtures/dist/types.d.ts:63 + +Options for [createMockStream](../functions/createMockStream.md). + +## Properties + +### delayMs? + +> `optional` **delayMs?**: `number` + +Defined in: test-fixtures/dist/types.d.ts:65 + +Delay in milliseconds between yielded items. diff --git a/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md b/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md new file mode 100644 index 0000000..e3e98a0 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/NormalizedMetric.md @@ -0,0 +1,55 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / NormalizedMetric + +# Interface: NormalizedMetric + +Defined in: testing/src/otel-collectors.ts:48 + +Structural representation of a single metric data point. + +## Properties + +### description + +> **description**: `string` + +Defined in: testing/src/otel-collectors.ts:50 + +*** + +### name + +> **name**: `string` + +Defined in: testing/src/otel-collectors.ts:49 + +*** + +### points + +> **points**: `object`[] + +Defined in: testing/src/otel-collectors.ts:53 + +#### attributes + +> **attributes**: `Record`\<`string`, `unknown`\> + +#### value + +> **value**: `unknown` + +*** + +### type + +> **type**: `string` + +Defined in: testing/src/otel-collectors.ts:52 + +*** + +### unit + +> **unit**: `string` + +Defined in: testing/src/otel-collectors.ts:51 diff --git a/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md b/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md new file mode 100644 index 0000000..6fdf149 --- /dev/null +++ b/en/api/@connectum/testing/index/interfaces/NormalizedSpan.md @@ -0,0 +1,87 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / NormalizedSpan + +# Interface: NormalizedSpan + +Defined in: testing/src/otel-collectors.ts:34 + +Structural, transport-agnostic representation of a span suitable for `deepEqual`. + +## Properties + +### attributes + +> **attributes**: `Record`\<`string`, `unknown`\> + +Defined in: testing/src/otel-collectors.ts:37 + +*** + +### events + +> **events**: `object`[] + +Defined in: testing/src/otel-collectors.ts:38 + +#### attributes + +> **attributes**: `Record`\<`string`, `unknown`\> + +#### name + +> **name**: `string` + +*** + +### kind + +> **kind**: `number` + +Defined in: testing/src/otel-collectors.ts:36 + +*** + +### name + +> **name**: `string` + +Defined in: testing/src/otel-collectors.ts:35 + +*** + +### parentSpanId + +> **parentSpanId**: `string` \| `undefined` + +Defined in: testing/src/otel-collectors.ts:42 + +*** + +### spanId + +> **spanId**: `string` + +Defined in: testing/src/otel-collectors.ts:41 + +*** + +### status + +> **status**: `object` + +Defined in: testing/src/otel-collectors.ts:39 + +#### code + +> **code**: `number` + +#### message + +> **message**: `string` \| `undefined` + +*** + +### traceId + +> **traceId**: `string` + +Defined in: testing/src/otel-collectors.ts:40 diff --git a/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md b/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md new file mode 100644 index 0000000..69a2703 --- /dev/null +++ b/en/api/@connectum/testing/index/variables/TRANSPORT_METRIC_ATTRIBUTE.md @@ -0,0 +1,9 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / TRANSPORT\_METRIC\_ATTRIBUTE + +# Variable: TRANSPORT\_METRIC\_ATTRIBUTE + +> `const` **TRANSPORT\_METRIC\_ATTRIBUTE**: `"transport"` = `"transport"` + +Defined in: testing/src/otel-collectors.ts:29 + +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 new file mode 100644 index 0000000..82e509d --- /dev/null +++ b/en/api/@connectum/testing/index/variables/TRANSPORT_SPAN_ATTRIBUTE.md @@ -0,0 +1,9 @@ +[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [index](../index.md) / TRANSPORT\_SPAN\_ATTRIBUTE + +# Variable: TRANSPORT\_SPAN\_ATTRIBUTE + +> `const` **TRANSPORT\_SPAN\_ATTRIBUTE**: `"connectum.transport"` = `"connectum.transport"` + +Defined in: testing/src/otel-collectors.ts:27 + +Span attribute key produced by `@connectum/otel` to distinguish transports. diff --git a/en/api/@connectum/testing/types/index.md b/en/api/@connectum/testing/types/index.md index 3fdf302..3e0d6ad 100644 --- a/en/api/@connectum/testing/types/index.md +++ b/en/api/@connectum/testing/types/index.md @@ -4,15 +4,58 @@ Type definitions for @connectum/testing. +Mock/fixture option types live in `@connectum/test-fixtures` and are +re-exported from this module for backwards compatibility. + ## Interfaces - [CreateTestServerOptions](interfaces/CreateTestServerOptions.md) -- [FakeMethodOptions](interfaces/FakeMethodOptions.md) -- [FakeServiceOptions](interfaces/FakeServiceOptions.md) -- [MockDescFieldOptions](interfaces/MockDescFieldOptions.md) -- [MockDescMessageOptions](interfaces/MockDescMessageOptions.md) -- [MockDescMethodOptions](interfaces/MockDescMethodOptions.md) -- [MockNextOptions](interfaces/MockNextOptions.md) -- [MockRequestOptions](interfaces/MockRequestOptions.md) -- [MockStreamOptions](interfaces/MockStreamOptions.md) - [TestServer](interfaces/TestServer.md) + +## References + +### FakeMethodOptions + +Re-exports [FakeMethodOptions](../index/interfaces/FakeMethodOptions.md) + +*** + +### FakeServiceOptions + +Re-exports [FakeServiceOptions](../index/interfaces/FakeServiceOptions.md) + +*** + +### MockDescFieldOptions + +Re-exports [MockDescFieldOptions](../index/interfaces/MockDescFieldOptions.md) + +*** + +### MockDescMessageOptions + +Re-exports [MockDescMessageOptions](../index/interfaces/MockDescMessageOptions.md) + +*** + +### MockDescMethodOptions + +Re-exports [MockDescMethodOptions](../index/interfaces/MockDescMethodOptions.md) + +*** + +### MockNextOptions + +Re-exports [MockNextOptions](../index/interfaces/MockNextOptions.md) + +*** + +### MockRequestOptions + +Re-exports [MockRequestOptions](../index/interfaces/MockRequestOptions.md) + +*** + +### MockStreamOptions + +Re-exports [MockStreamOptions](../index/interfaces/MockStreamOptions.md) diff --git a/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md b/en/api/@connectum/testing/types/interfaces/CreateTestServerOptions.md index 465a91c..90cadf6 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: [types.ts:126](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L126) +Defined in: [testing/src/types.ts:38](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/testing/src/types.ts#L38) Options for createTestServer. @@ -12,7 +12,7 @@ Options for createTestServer. > `optional` **interceptors?**: `unknown`[] -Defined in: [types.ts:130](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L130) +Defined in: [testing/src/types.ts:42](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/testing/src/types.ts#L42) Interceptors to apply. Default: `[]` @@ -22,7 +22,7 @@ Interceptors to apply. Default: `[]` > `optional` **port?**: `number` -Defined in: [types.ts:134](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L134) +Defined in: [testing/src/types.ts:46](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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: [types.ts:132](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L132) +Defined in: [testing/src/types.ts:44](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/testing/src/types.ts#L44) Protocol extensions (Healthcheck, Reflection). Default: `[]` @@ -42,6 +42,6 @@ Protocol extensions (Healthcheck, Reflection). Default: `[]` > **services**: `unknown`[] -Defined in: [types.ts:128](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L128) +Defined in: [testing/src/types.ts:40](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/testing/src/types.ts#L40) ConnectRPC service route handlers. diff --git a/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md b/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md deleted file mode 100644 index 2070c92..0000000 --- a/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / FakeMethodOptions - -# Interface: FakeMethodOptions - -Defined in: [types.ts:102](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L102) - -Options for createFakeMethod. - -## Properties - -### methodKind? - -> `optional` **methodKind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` - -Defined in: [types.ts:104](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L104) - -Method kind. Default: `'unary'` - -*** - -### register? - -> `optional` **register?**: `boolean` - -Defined in: [types.ts:106](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L106) - -Whether to register the method in service.methods. Default: `false` diff --git a/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md b/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md deleted file mode 100644 index 719dcf5..0000000 --- a/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / FakeServiceOptions - -# Interface: FakeServiceOptions - -Defined in: [types.ts:94](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L94) - -Options for createFakeService. - -## Properties - -### name? - -> `optional` **name?**: `string` - -Defined in: [types.ts:98](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L98) - -Service name (short). Default: derived from typeName - -*** - -### typeName? - -> `optional` **typeName?**: `string` - -Defined in: [types.ts:96](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L96) - -Service type name. Default: `'test.v1.TestService'` diff --git a/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md b/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md deleted file mode 100644 index 4b73a66..0000000 --- a/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md +++ /dev/null @@ -1,37 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / MockDescFieldOptions - -# Interface: MockDescFieldOptions - -Defined in: [types.ts:58](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L58) - -Options for createMockDescField. - -## Properties - -### fieldNumber? - -> `optional` **fieldNumber?**: `number` - -Defined in: [types.ts:62](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L62) - -Proto field number. Default: auto-incremented - -*** - -### isSensitive? - -> `optional` **isSensitive?**: `boolean` - -Defined in: [types.ts:60](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L60) - -Mark field as sensitive (for redact interceptor). Default: `false` - -*** - -### type? - -> `optional` **type?**: `string` - -Defined in: [types.ts:64](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L64) - -Field scalar type. Default: `'string'` diff --git a/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md b/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md deleted file mode 100644 index 3eea736..0000000 --- a/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md +++ /dev/null @@ -1,39 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / MockDescMessageOptions - -# Interface: MockDescMessageOptions - -Defined in: [types.ts:46](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L46) - -Options for createMockDescMessage. - -## Properties - -### fields? - -> `optional` **fields?**: `object`[] - -Defined in: [types.ts:48](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L48) - -Field definitions. Default: `[]` - -#### fieldNumber? - -> `optional` **fieldNumber?**: `number` - -#### name - -> **name**: `string` - -#### type? - -> `optional` **type?**: `string` - -*** - -### oneofs? - -> `optional` **oneofs?**: `string`[] - -Defined in: [types.ts:54](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L54) - -Oneof group names. Default: `[]` diff --git a/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md b/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md deleted file mode 100644 index 8173e9d..0000000 --- a/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md +++ /dev/null @@ -1,47 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / MockDescMethodOptions - -# Interface: MockDescMethodOptions - -Defined in: [types.ts:68](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L68) - -Options for createMockDescMethod. - -## Properties - -### input? - -> `optional` **input?**: `DescMessage` - -Defined in: [types.ts:70](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L70) - -Input message descriptor. - -*** - -### kind? - -> `optional` **kind?**: `"unary"` \| `"client_streaming"` \| `"server_streaming"` \| `"bidi_streaming"` - -Defined in: [types.ts:74](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L74) - -Method kind. Default: `'unary'` - -*** - -### output? - -> `optional` **output?**: `DescMessage` - -Defined in: [types.ts:72](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L72) - -Output message descriptor. - -*** - -### useSensitiveRedaction? - -> `optional` **useSensitiveRedaction?**: `boolean` - -Defined in: [types.ts:76](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L76) - -Enable sensitive field redaction for this method. Default: `false` diff --git a/en/api/@connectum/testing/types/interfaces/MockNextOptions.md b/en/api/@connectum/testing/types/interfaces/MockNextOptions.md deleted file mode 100644 index b851df2..0000000 --- a/en/api/@connectum/testing/types/interfaces/MockNextOptions.md +++ /dev/null @@ -1,27 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / MockNextOptions - -# Interface: MockNextOptions - -Defined in: [types.ts:34](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L34) - -Options for createMockNext and createMockNextSlow. - -## Properties - -### message? - -> `optional` **message?**: `unknown` - -Defined in: [types.ts:36](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L36) - -Response message. Default: `{ result: 'success' }` - -*** - -### stream? - -> `optional` **stream?**: `boolean` - -Defined in: [types.ts:38](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L38) - -Streaming response flag. Default: `false` diff --git a/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md b/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md deleted file mode 100644 index efd2e58..0000000 --- a/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md +++ /dev/null @@ -1,67 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / MockRequestOptions - -# Interface: MockRequestOptions - -Defined in: [types.ts:14](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L14) - -Options for createMockRequest. - -## Properties - -### headers? - -> `optional` **headers?**: `Headers` - -Defined in: [types.ts:26](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L26) - -Request headers. Default: `new Headers()` - -*** - -### message? - -> `optional` **message?**: `unknown` - -Defined in: [types.ts:20](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L20) - -Request message payload. Default: `{}` - -*** - -### method? - -> `optional` **method?**: `string` - -Defined in: [types.ts:18](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L18) - -Method name. Default: `'TestMethod'` - -*** - -### service? - -> `optional` **service?**: `string` - -Defined in: [types.ts:16](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L16) - -Service type name. Default: `'test.TestService'` - -*** - -### stream? - -> `optional` **stream?**: `boolean` - -Defined in: [types.ts:22](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L22) - -Streaming request flag. Default: `false` - -*** - -### url? - -> `optional` **url?**: `string` - -Defined in: [types.ts:24](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L24) - -Request URL. Auto-generated from service/method if omitted. diff --git a/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md b/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md deleted file mode 100644 index 4541516..0000000 --- a/en/api/@connectum/testing/types/interfaces/MockStreamOptions.md +++ /dev/null @@ -1,17 +0,0 @@ -[Connectum API Reference](../../../../index.md) / [@connectum/testing](../../index.md) / [types](../index.md) / MockStreamOptions - -# Interface: MockStreamOptions - -Defined in: [types.ts:84](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L84) - -Options for createMockStream. - -## Properties - -### delayMs? - -> `optional` **delayMs?**: `number` - -Defined in: [types.ts:86](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L86) - -Delay in milliseconds between yielded items. diff --git a/en/api/@connectum/testing/types/interfaces/TestServer.md b/en/api/@connectum/testing/types/interfaces/TestServer.md index 06a0128..de1f0e5 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: [types.ts:114](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L114) +Defined in: [testing/src/types.ts:26](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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: [types.ts:118](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L118) +Defined in: [testing/src/types.ts:30](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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: [types.ts:120](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L120) +Defined in: [testing/src/types.ts:32](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/testing/src/types.ts#L32) Assigned port number. @@ -32,7 +32,7 @@ Assigned port number. > **transport**: `Transport` -Defined in: [types.ts:116](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L116) +Defined in: [testing/src/types.ts:28](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/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: [types.ts:122](https://github.com/Connectum-Framework/connectum/blob/acbe73ae0e923dc7b46c1b4a6241f3e342535af7/packages/testing/src/types.ts#L122) +Defined in: [testing/src/types.ts:34](https://github.com/Connectum-Framework/connectum/blob/9c808efa603eaacdf10ddef6780ea699f46a1f35/packages/testing/src/types.ts#L34) Stop the server and close all connections. diff --git a/en/api/index.md b/en/api/index.md index 2183a2c..84defdd 100644 --- a/en/api/index.md +++ b/en/api/index.md @@ -14,4 +14,5 @@ - [@connectum/interceptors](@connectum/interceptors/index.md) - [@connectum/otel](@connectum/otel/index.md) - [@connectum/reflection](@connectum/reflection/index.md) +- [@connectum/test-fixtures](@connectum/test-fixtures/index.md) - [@connectum/testing](@connectum/testing/index.md) diff --git a/en/api/typedoc-sidebar.json b/en/api/typedoc-sidebar.json index 8c8b079..f25a1f8 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":"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":"ServiceRoute","link":"/en/api/@connectum/core/types/type-aliases/ServiceRoute.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":"Interfaces","collapsed":true,"items":[{"text":"SanitizableError","link":"/en/api/@connectum/core/interfaces/SanitizableError.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"ConnectumEnv","link":"/en/api/@connectum/core/type-aliases/ConnectumEnv.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":"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":"Functions","collapsed":true,"items":[{"text":"createServer","link":"/en/api/@connectum/core/functions/createServer.md"},{"text":"getTLSPath","link":"/en/api/@connectum/core/functions/getTLSPath.md"},{"text":"isSanitizableError","link":"/en/api/@connectum/core/functions/isSanitizableError.md"},{"text":"parseEnvConfig","link":"/en/api/@connectum/core/functions/parseEnvConfig.md"},{"text":"readTLSCertificates","link":"/en/api/@connectum/core/functions/readTLSCertificates.md"},{"text":"safeParseEnvConfig","link":"/en/api/@connectum/core/functions/safeParseEnvConfig.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":"AmqpConsumerOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md"},{"text":"AmqpExchangeOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md"},{"text":"AmqpPublisherOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md"},{"text":"AmqpQueueOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.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":"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_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":"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":"Functions","collapsed":true,"items":[{"text":"getProvider","link":"/en/api/@connectum/otel/provider/functions/getProvider.md"},{"text":"initProvider","link":"/en/api/@connectum/otel/provider/functions/initProvider.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":"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/testing","link":"/en/api/@connectum/testing/","collapsed":true,"items":[{"text":"index","link":"/en/api/@connectum/testing/index/","collapsed":true,"items":[{"text":"Interfaces","collapsed":true,"items":[{"text":"MockCall","link":"/en/api/@connectum/testing/index/interfaces/MockCall.md"},{"text":"MockFn","link":"/en/api/@connectum/testing/index/interfaces/MockFn.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":"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":"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":"FakeMethodOptions","link":"/en/api/@connectum/testing/types/interfaces/FakeMethodOptions.md"},{"text":"FakeServiceOptions","link":"/en/api/@connectum/testing/types/interfaces/FakeServiceOptions.md"},{"text":"MockDescFieldOptions","link":"/en/api/@connectum/testing/types/interfaces/MockDescFieldOptions.md"},{"text":"MockDescMessageOptions","link":"/en/api/@connectum/testing/types/interfaces/MockDescMessageOptions.md"},{"text":"MockDescMethodOptions","link":"/en/api/@connectum/testing/types/interfaces/MockDescMethodOptions.md"},{"text":"MockNextOptions","link":"/en/api/@connectum/testing/types/interfaces/MockNextOptions.md"},{"text":"MockRequestOptions","link":"/en/api/@connectum/testing/types/interfaces/MockRequestOptions.md"},{"text":"MockStreamOptions","link":"/en/api/@connectum/testing/types/interfaces/MockStreamOptions.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":"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":"ServiceRoute","link":"/en/api/@connectum/core/types/type-aliases/ServiceRoute.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":"Interfaces","collapsed":true,"items":[{"text":"CreateLocalTransportOptions","link":"/en/api/@connectum/core/interfaces/CreateLocalTransportOptions.md"},{"text":"SanitizableError","link":"/en/api/@connectum/core/interfaces/SanitizableError.md"}]},{"text":"Type Aliases","collapsed":true,"items":[{"text":"ConnectumEnv","link":"/en/api/@connectum/core/type-aliases/ConnectumEnv.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":"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":"Functions","collapsed":true,"items":[{"text":"createLocalTransport","link":"/en/api/@connectum/core/functions/createLocalTransport.md"},{"text":"createServer","link":"/en/api/@connectum/core/functions/createServer.md"},{"text":"getTLSPath","link":"/en/api/@connectum/core/functions/getTLSPath.md"},{"text":"isSanitizableError","link":"/en/api/@connectum/core/functions/isSanitizableError.md"},{"text":"parseEnvConfig","link":"/en/api/@connectum/core/functions/parseEnvConfig.md"},{"text":"readTLSCertificates","link":"/en/api/@connectum/core/functions/readTLSCertificates.md"},{"text":"safeParseEnvConfig","link":"/en/api/@connectum/core/functions/safeParseEnvConfig.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":"AmqpConsumerOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpConsumerOptions.md"},{"text":"AmqpExchangeOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpExchangeOptions.md"},{"text":"AmqpPublisherOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpPublisherOptions.md"},{"text":"AmqpQueueOptions","link":"/en/api/@connectum/events-amqp/types/interfaces/AmqpQueueOptions.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":"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":"Functions","collapsed":true,"items":[{"text":"getProvider","link":"/en/api/@connectum/otel/provider/functions/getProvider.md"},{"text":"initProvider","link":"/en/api/@connectum/otel/provider/functions/initProvider.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":"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":"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":"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":"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":"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 diff --git a/en/contributing/parity-coverage.md b/en/contributing/parity-coverage.md new file mode 100644 index 0000000..33585ce --- /dev/null +++ b/en/contributing/parity-coverage.md @@ -0,0 +1,80 @@ +# Parity Coverage Report + +This page reports the current coverage of the +[cross-transport parity invariant](./parity-invariant.md). It is updated +manually when parity scenarios are added or removed; the underlying numbers +can be regenerated from the parity test files at any time. + +> **Last updated:** Phase 7 of OpenSpec change `in-process-transport`. +> **Target coverage:** ≥ 90 % of observable behaviour exercised through the +> `transportParityTest()` driver. + +## Scenarios by group + +| Group | Surface | File | Scenarios | +|------:|---------|------|----------:| +| 3 | Interceptors smoke (timeout, retry, bulkhead, circuit-breaker, logger, serializer, errorHandler, method-filter) | `packages/testing/tests/parity/interceptors.parity.test.ts` | **8** | +| 3a | `protovalidate` / `buf.validate` (success, single-rule violation, aggregated violations, streaming validation) | `packages/testing/tests/parity/validation.parity.test.ts` | **4** | +| 3b | Proto-declared authz (success with scope, unauthenticated, permission denied, public method) | `packages/testing/tests/parity/authorization.parity.test.ts` | **4** | +| 4 | Streaming & cancellation (unary, server-stream, client-stream, bidi, unary cancel, stream mid-cancel) | `packages/testing/tests/parity/streaming.parity.test.ts` | **6** | +| 5 | Error mapping (`ConnectError(NotFound)`, plain `Error` → `internal`, interceptor-thrown error) | `packages/testing/tests/parity/errors.parity.test.ts` | **3** | +| 6 | HTTP / local coexistence (concurrent observation by one interceptor; `server.start()` not required for local invoke) | `packages/testing/tests/parity/coexistence.parity.test.ts` + `packages/core/tests/integration/localTransport.test.ts` | **2** | +| 7a | OTEL tracing & metrics (unary spans, streaming events, error spans, metrics labels, trace-context propagation, instrument subset, `connectum.transport` attribute) | `packages/otel/tests/parity/otel.parity.test.ts` | **7** | +| **Total** | | | **34** | + +Of these, **25 scenarios** (groups 3, 3a, 3b, 4, 5) go through the unified +`transportParityTest()` driver in `@connectum/testing/parity` and produce a +structural diff between HTTP and local. The 7 OTEL scenarios and 2 coexistence +scenarios are written as paired `test()` cases that drive both transports +explicitly and assert equality of observable signals — semantically equivalent +to the driver, but expressed in long form because they need bespoke +exporter setup (OTEL) or asymmetric assertions (coexistence). + +## Coverage analysis + +Observable behaviours that a service can produce, and their current parity +coverage: + +| Observable behaviour | Covered | +|---|:---:| +| Response payload (unary) | ✅ groups 3a / 3b / 5 | +| Response payload (streaming) | ✅ group 4 | +| Response headers / trailers | ✅ group 3 (via driver diff) | +| `ConnectError` code / message | ✅ groups 3a / 3b / 5 | +| `ConnectError` metadata / details | ✅ groups 3a / 3b | +| Streaming message order | ✅ group 4 | +| Cancellation propagation | ✅ group 4 (5, 6) | +| Interceptor chain order | ✅ group 3 | +| Validation interceptor outcomes | ✅ group 3a | +| Auth/authz interceptor outcomes | ✅ group 3b | +| OTEL span attributes / status | ✅ group 7a | +| OTEL span events (streaming) | ✅ group 7a | +| OTEL trace-context propagation | ✅ group 7a | +| OTEL metrics (names, labels, values) | ✅ group 7a | +| Coexistence (one server, two transports) | ✅ group 6 | +| Server lifecycle (local before `start()`) | ✅ group 6.2 | + +Behaviours **not** covered by parity (by design, see +[`parity-invariant.md`](./parity-invariant.md#when-parity-does-not-apply)): +TLS, HTTP/2 framing, content-encoding negotiation, `:authority` / +real-host `req.url`, gzip — these are wire-only and have no in-process +analogue. + +**Coverage estimate:** of 16 distinct observable behaviour categories above, +all 16 are exercised through the parity mechanism. The 4 explicitly +out-of-scope categories (TLS, HTTP/2 framing, content-encoding, real +`req.url` host) are wire-specific and excluded by spec. + +Observable coverage: **16 / 16 = 100 %** of in-scope behaviours; +**16 / 20 = 80 %** if wire-only behaviours are counted as denominator. +By the spec's "observable behaviour" definition (wire-only is excluded), +coverage clears the 90 % target. + +## How to add a scenario + +1. Pick the right file in `packages/testing/tests/parity/` (or + `packages/otel/tests/parity/` for observability). +2. For most cases, wrap the scenario with + `transportParityTest("group N.M: short title", async ({ transport }) => …)`. +3. Run `./scripts/parity-suite.sh` locally. +4. Update the table above. diff --git a/en/contributing/parity-invariant.md b/en/contributing/parity-invariant.md new file mode 100644 index 0000000..4f5863d --- /dev/null +++ b/en/contributing/parity-invariant.md @@ -0,0 +1,85 @@ +# Cross-Transport Parity Invariant + +Connectum exposes two transports for ConnectRPC services: + +- the **HTTP/2 transport** — the production wire protocol; +- the **in-process transport** — `createLocalTransport(server)` / + `Server.client(ServiceDesc)`, which delivers requests directly into the + registered route handlers without serialization or a socket. + +The framework guarantees a **Behavioural Parity** invariant between them: + +> For every observable behaviour of a ConnectRPC service, the in-process +> transport produces results that structurally match the HTTP/2 transport. +> Observable behaviours include response payloads, response headers and +> trailers, `ConnectError` codes / messages / metadata / `details`, the order +> of streaming messages, cancellation propagation, OpenTelemetry spans +> (modulo the `connectum.transport` attribute), and metric label sets +> (modulo the `transport` label). + +This invariant is **release-blocking**: any PR that breaks it must either be +revised or accompanied by a documented carve-out in the spec. + +## How the invariant is enforced + +1. **`transportParityTest()` driver** (`@connectum/testing/parity`) runs every + scenario twice — once over `createGrpcTransport({ baseUrl })` and once over + `createLocalTransport(server)` — and performs a structural diff on the + normalized result (response, headers, error, OTEL spans, metrics). +2. **Parity suite** — aggregated by `scripts/parity-suite.sh`, covering + interceptors, validation, authorization, streaming, error mapping, + coexistence, and OTEL. +3. **`parity-gate` CI job** (`.github/workflows/parity-gate.yml`) runs the + suite on every pull request and every push to `main`. + +## When you MUST add a parity scenario + +Any change that touches **observable RPC behaviour** must add (or extend) a +`transportParityTest()` scenario in the appropriate file under +`packages/testing/tests/parity/` (or `packages/otel/tests/parity/` for +observability). This includes, but is not limited to: + +- a new interceptor in `@connectum/interceptors`; +- a new authentication or authorization rule in `@connectum/auth` + (programmatic or proto-declared); +- a new validation rule wired through `protovalidate` / `buf.validate`; +- a new OpenTelemetry instrument, attribute, or span event in + `@connectum/otel`; +- any change to `ConnectError` mapping in `@connectum/core` or interceptors; +- any change to header / trailer propagation; +- any change to streaming semantics (ordering, cancellation, back-pressure + surfaces). + +If the change is purely transport-local — for example, an HTTP-only header +that has no in-process analogue — document the carve-out in the parity test +file as a code comment **and** in the spec. + +## When parity does not apply + +A small set of behaviours are explicitly transport-specific and are +**not** asserted by the parity driver: + +- Network-level concerns: TLS, HTTP/2 framing, TCP keepalive, `:authority` + pseudo-header, real `req.url` host/port. +- Wire-format concerns: gzip/identity content-encoding negotiation, message + framing on the wire. +- The synthetic origin `https://in-memory/` that the in-process + transport injects for interceptors that read `req.url`. +- The `connectum.transport` span attribute and the `transport` metric label, + which differ by design and are stripped before structural diff. + +## Pull request checklist + +Every PR that touches a service-observable surface must: + +- [ ] add or extend a `transportParityTest()` scenario covering the change, **or** +- [ ] explicitly mark the change as `parity: N/A` in the PR description and + justify why. + +The `parity-gate` CI job will block merge on any structural diff. + +## References + +- [In-process transport guide](../guide/production/in-process-transport.md) +- [Parity coverage report](./parity-coverage.md) +- Internal design notes: see ADR for in-process transport (registry-based local invoke) diff --git a/en/guide/production/architecture.md b/en/guide/production/architecture.md index 94f1859..4f8b2c8 100644 --- a/en/guide/production/architecture.md +++ b/en/guide/production/architecture.md @@ -209,6 +209,21 @@ const routes = (router) => { }; ``` +### In-Process Transport (Co-Located Services) + +When the caller and callee live in the same Node.js process — modular monoliths, BFFs, or test harnesses — Connectum offers an **in-process transport** that dispatches client calls directly to the registered handler. No HTTP/2 socket, no TLS handshake, no wire serialization, while the full server-side interceptor chain (validation, authorization, OpenTelemetry) still runs. The client API is identical to the remote one (`createClient(Service, transport)`), so the same call site works for both topologies via `server.client(Service, { fallback })` auto-routing. + +```typescript +import { createServer } from '@connectum/core'; + +const server = createServer({ services: [inventoryRoutes, orderRoutes] }); + +// Local if registered on this server, remote via fallback otherwise. +const inventory = server.client(InventoryService, { fallback: remoteTransport }); +``` + +See [In-Process Transport](/en/guide/production/in-process-transport) for the polyglot deployment pattern, observability parity, and limitations. + ## Service Discovery ### gRPC Server Reflection diff --git a/en/guide/production/in-process-transport.md b/en/guide/production/in-process-transport.md new file mode 100644 index 0000000..7215998 --- /dev/null +++ b/en/guide/production/in-process-transport.md @@ -0,0 +1,224 @@ +--- +title: In-Process Transport +description: Call locally registered Connectum services as plain function invocations — no HTTP/2, TLS, or wire serialization — with full behavioural parity to the HTTP transport. +--- + +# In-Process Transport + +The **in-process transport** lets you invoke services that are registered on the same `Server` instance as direct function calls — without HTTP/2, TLS, sockets, or wire serialization — while preserving 1-to-1 behavioural parity with the HTTP/Connect/gRPC transport (interceptors, validation, authorization, error mapping, streaming semantics, OpenTelemetry spans and metrics). + +::: tip Full API Reference +TypeScript API documentation: [@connectum/core API Reference](/en/api/@connectum/core/). +::: + +## Overview + +A typical Connectum service-to-service call goes over HTTP/2 loopback even when both endpoints live in the same Node.js process. That adds TLS handshakes, h2 framing, JSON/protobuf wire encoding, and a port binding — overhead that is pure waste for co-located services. + +The in-process transport reuses the `ConnectRouter` that `createServer()` has already built and dispatches client calls directly to the registered handlers. The client API is identical to a remote ConnectRPC client (`createClient(Service, transport)`), so the same caller code works whether the callee is local or remote. + +**When to use:** + +- **Modular monolith** — multiple bounded contexts hosted in a single process call each other over typed RPC contracts without the network overhead. +- **Backend-for-Frontend (BFF)** — a BFF process embeds upstream services for low-latency composition. +- **Tests** — exercise the full server-side interceptor chain (validation, auth, OTEL) without binding ports. +- **Polyglot deployment** — a single client codebase that automatically routes to a local registered service or falls back to a remote HTTP transport based on the runtime topology. + +**When NOT to use:** + +- **Cross-process calls** — use `createGrpcTransport` / `createConnectTransport` over HTTP/2. The in-process transport is, by design, single-process only. +- **HTTP-level middleware** — CORS, compression, and similar wire-level concerns do not apply because no data leaves the process. + +## Quick Start + +```typescript +import { createServer } from '@connectum/core'; +import { GreeterService } from './gen/greeter_pb.js'; +import { greeterRoutes } from './greeter.js'; + +const server = createServer({ + services: [greeterRoutes], +}); + +// Auto-routing: resolved via the in-process service registry, +// no server.start() required. +const greeter = server.client(GreeterService); + +const { message } = await greeter.sayHello({ name: 'world' }); +console.log(message); // "Hello, world!" +``` + +The call above executes the full server-side interceptor chain (including validation and authorization) and emits the same OpenTelemetry CLIENT and SERVER spans as an equivalent HTTP call — only the `connectum.transport` attribute differs. + +## API Reference + +### `server.client(service, options?)` + +Auto-routing client factory. Resolves the transport via the server's internal **service registry**: + +- If the service is registered on this `Server` (`server.hasService(service)` returns `true`) — returns an in-process client that dispatches directly to the registered handler. +- Otherwise, if `options.fallback` is provided — returns a standard ConnectRPC client over the fallback transport. +- Otherwise — throws `ConnectError(unimplemented)` immediately at client construction (fail-fast), naming the service `typeName`. + +```typescript +function client( + service: T, + options?: { fallback?: Transport }, +): Client; +``` + +This is the recommended entry point: the same call site works for both in-process and remote deployments without modification. + +```typescript +import { createGrpcTransport } from '@connectrpc/connect-node'; + +const remoteFallback = createGrpcTransport({ + baseUrl: process.env.UPSTREAM_URL!, + httpVersion: '2', +}); + +// Local if registered on `server`, remote otherwise. +const inventory = server.client(InventoryService, { fallback: remoteFallback }); +``` + +### `server.localClient(service)` + +Low-level helper that always returns an in-process client. Requires the service to be registered on the server — otherwise the first call throws `ConnectError(unimplemented)`. + +```typescript +function localClient(service: T): Client; +``` + +### `createLocalTransport(server, options?)` + +Lowest-level primitive. Returns a ConnectRPC `Transport` bound to the server's router. Use this directly when you need multiple clients with different client-side interceptor stacks over the same server. + +```typescript +function createLocalTransport( + server: Server, + options?: { interceptors?: Interceptor[] }, +): Transport; +``` + +The returned transport behaves like `createRouterTransport` from `@connectrpc/connect` but is wired into the Connectum server lifecycle and the same router that `server.start()` would expose over HTTP. + +### `server.hasService(desc)` + +Synchronous registry lookup by `desc.typeName`. + +```typescript +function hasService(desc: DescService): boolean; +``` + +Useful for conditional routing in user code (e.g. when you build a custom transport selector). + +## Behavioural Parity Guarantees + +The in-process transport is validated by a cross-transport contract test suite (`transportParityTest` driver in `@connectum/testing`). For every covered scenario, the observed result over `createLocalTransport(server)` is structurally identical to the result over `createGrpcTransport({ baseUrl })` — modulo a single allow-listed attribute / label (`connectum.transport` / `transport`). + +Guaranteed identical between in-process and HTTP: + +- **Server-side interceptor chain** — same interceptors, same order. There is no API to bypass interceptors on the local path. +- **Validation** — proto-declared `buf.validate` / `protovalidate` rules reject invalid requests with `ConnectError(invalid_argument)` and identical violation details on both transports. +- **Authorization** — proto-declared authz rules and `@connectum/auth` interceptors apply uniformly. Missing/invalid tokens produce `ConnectError(unauthenticated)`; insufficient scope produces `ConnectError(permission_denied)` with identical metadata. +- **Error mapping** — `ConnectError` (`code`, `message`, `metadata`, `details`) round-trips identically. Plain `Error` becomes `code === internal` on both paths. +- **Streaming** — unary, server-stream, client-stream, and bidi RPCs preserve message order and respect `AbortSignal` cancellation on both paths. +- **Headers / metadata** — `Headers` objects (including `authorization` and `@connectum/auth` serialized auth headers) round-trip in both directions. Headers are cloned at the boundary to prevent cross-side mutation. +- **OpenTelemetry tracing and metrics** — see [Observability](#observability) below. + +## Observability + +`@connectum/otel` instruments the in-process path through the same hooks as HTTP: + +- **Client span**: `SpanKind.CLIENT`, name `${rpc.service}/${rpc.method}`, attributes `rpc.system`, `rpc.service`, `rpc.method`, `rpc.grpc.status_code`, plus `connectum.transport="in-process"`. +- **Server span**: `SpanKind.SERVER` with the same attribute set; established as a **child** of the client span via W3C Trace Context (`traceparent` / `tracestate`) carried through the in-memory `Headers`. +- **Stream events**: `message.sent` and `message.received` are recorded on streaming spans identically to HTTP. +- **Metrics**: `rpc.client.duration`, `rpc.server.duration`, `rpc.client.request.size`, `rpc.client.response.size`, `rpc.server.request.size`, `rpc.server.response.size`, and error counters are emitted with the same instrument names and label keys. Payload sizes are computed on the serialized protobuf form so they are directly comparable with HTTP. The only difference is an extra label `transport=in-process` (vs `transport=http`). + +Dashboards, alerts, and SLOs built over HTTP metrics continue to work after a service migrates to in-process invocation. + +## Limitations + +By design, the in-process transport bypasses HTTP-wire concerns: + +- **No HTTP-level middleware** — CORS, compression, HTTP/2 flow control, request body size limits, and similar features do not apply because no bytes leave the process. +- **No cross-process / IPC** — for cross-process communication (Unix sockets, separate hosts, worker_threads) use HTTP transports. +- **Streaming back-pressure** is provided by `AsyncIterable` semantics and is best-effort rather than HTTP/2 flow control. For very high-throughput streaming, prefer HTTP/2. +- **Payload objects are shared by reference** inside the same process (as in any function call). Do not mutate request/response payloads after handing them off. `Headers` are explicitly cloned at the boundary. + +## Coexistence with HTTP + +A single `Server` instance can simultaneously serve HTTP clients (after `server.start()`) and in-process clients (available immediately after `createServer()`). Both paths go through the same router and the same interceptor chain, so an interceptor observes both kinds of calls uniformly. + +```typescript +const server = createServer({ services: [routes] }); + +// In-process client works immediately, no socket bound. +const local = server.client(MyService); +await local.doWork({ /* ... */ }); + +// Bind HTTP/2 socket for external clients. +await server.start(); + +// HTTP and in-process clients can be used concurrently. +``` + +If you do not call `server.start()`, no port is bound and `server.address` remains `null` — useful for tests and embedded use cases. + +## Polyglot Deployment Pattern + +The auto-routing `server.client()` enables a single caller codebase that works in both monolithic and distributed deployments. + +```typescript +// shared/clients.ts — same code in every deployment topology +export function buildClients(server: Server, env: { upstreamUrl?: string }) { + const fallback = env.upstreamUrl + ? createGrpcTransport({ baseUrl: env.upstreamUrl, httpVersion: '2' }) + : undefined; + + return { + inventory: server.client(InventoryService, { fallback }), + pricing: server.client(PricingService, { fallback }), + }; +} +``` + +- **Monolith deployment**: register `InventoryService` and `PricingService` on the same `server`. Both clients route locally. +- **Distributed deployment**: register only the services owned by this process. Others fall back to the remote transport. No change at the call site. +- **Hybrid migration**: extract one service at a time. The client side never changes. + +If a service is not registered locally and no fallback is provided, `server.client()` throws `ConnectError(unimplemented)` at construction — a fail-fast signal that deployment topology is misconfigured. + +## Testing + +`@connectum/testing` ships dedicated helpers for in-process testing: + +- **`createLocalClient(server, service)`** — concise client for unit and integration tests without binding ports. +- **`transportParityTest(name, scenario)`** — driver that runs a single declarative scenario against both `createGrpcTransport({ baseUrl })` and `createLocalTransport(server)` and structurally diffs the observable outcome (response payload, headers, `ConnectError` fields, OTEL spans modulo `connectum.transport`, metrics modulo `transport` label). Any divergence fails the test. +- **In-memory OTEL collectors** — `SpanExporter` and `MetricReader` helpers used by the parity driver for assertion on tracing and metrics output. + +Use the parity driver to guarantee that custom interceptors and proto-declared rules behave identically across transports: + +```typescript +import { transportParityTest } from '@connectum/testing'; + +await transportParityTest('greeter.sayHello rejects empty name', { + // build the client over the provided transport + client: (transport) => createClient(GreeterService, transport), + // run the scenario and return observable outcome + scenario: async (client) => client.sayHello({ name: '' }), + expect: { + error: { code: 'invalid_argument' }, + }, +}); +``` + +See [@connectum/testing](/en/packages/testing) for the full API. + +## See Also + +- [@connectum/core — In-Process Transport](/en/packages/core#in-process-transport) +- [@connectum/otel](/en/packages/otel) — `connectum.transport` attribute and `transport` metric label +- [@connectum/testing](/en/packages/testing) — `createLocalClient`, `transportParityTest` +- [Microservice Architecture Patterns](/en/guide/production/architecture) +- [API Reference: @connectum/core](/en/api/@connectum/core/) diff --git a/en/packages/core.md b/en/packages/core.md index 9985971..2ffb5b6 100644 --- a/en/packages/core.md +++ b/en/packages/core.md @@ -161,6 +161,40 @@ interface Server { } ``` +### In-Process Transport + +`@connectum/core` ships a built-in **in-process transport** that lets you call locally registered services as direct function invocations — no HTTP/2, TLS, sockets, or wire serialization — while preserving 1-to-1 behavioural parity with the HTTP path (interceptors, validation, authorization, error mapping, streaming semantics, OpenTelemetry spans and metrics). + +```typescript +import { createServer, createLocalTransport } from '@connectum/core'; +import { GreeterService } from './gen/greeter_pb.js'; + +const server = createServer({ services: [greeterRoutes] }); + +// Auto-routing client: in-process if `GreeterService` is registered on +// this server, else uses `options.fallback`, else throws unimplemented. +const greeter = server.client(GreeterService); +await greeter.sayHello({ name: 'world' }); // no server.start() needed + +// Low-level helpers: +const localOnly = server.localClient(GreeterService); +const transport = createLocalTransport(server, { interceptors: [/* client-side */] }); +const isRegistered = server.hasService(GreeterService); +``` + +| API | Description | +|-----|-------------| +| `server.client(service, options?)` | Auto-routing factory: local if registered, else `options.fallback`, else fail-fast `ConnectError(unimplemented)`. | +| `server.localClient(service)` | Low-level helper that always returns an in-process client. | +| `server.hasService(desc)` | Synchronous registry lookup by `desc.typeName`. | +| `createLocalTransport(server, options?)` | Returns a ConnectRPC `Transport` bound to the server's router; supports client-side interceptors. | + +The in-process transport is available immediately after `createServer({...})` — `server.start()` is **not** required. A single `Server` instance can serve HTTP and in-process clients concurrently. + +::: tip See the dedicated guide +[In-Process Transport](/en/guide/production/in-process-transport) — motivation, polyglot deployment pattern, observability parity, limitations. +::: + ### `ServerState` ```typescript @@ -316,6 +350,7 @@ See [Runtime Support: Node.js vs Bun vs tsx](/en/guide/typescript#runtime-suppor | Export | Subpath | Description | |--------|---------|-------------| | `createServer` | `.` | Server factory function | +| `createLocalTransport` | `.` | In-process transport factory ([guide](/en/guide/production/in-process-transport)) | | `ServerState` | `.` | Server state constants | | `LifecycleEvent` | `.` | Lifecycle event name constants | | `isSanitizableError` | `.` | Type guard for `SanitizableError` protocol | diff --git a/en/packages/otel.md b/en/packages/otel.md index 5ddb680..8670db3 100644 --- a/en/packages/otel.md +++ b/en/packages/otel.md @@ -331,6 +331,77 @@ import { | `ATTR_*`, `ConnectErrorCode`, etc. | `.` / `./attributes` | Semantic conventions | | `ExporterType`, `getOTLPSettings`, etc. | `.` / `./config` | Configuration utilities | +## In-Process Transport + +The OTel interceptors are fully transport-aware: spans and RPC metrics are +recorded identically whether a call traversed the network (`createGrpcTransport`) +or the in-process router (`createLocalTransport` from `@connectum/core`). + +The only deliberate difference between the two paths is a single +provenance tag — every span carries a `connectum.transport` attribute and +every RPC metric data point carries a `transport` label: + +| Path | `connectum.transport` span attribute | `transport` metric label | +|------|--------------------------------------|--------------------------| +| `createGrpcTransport(...)` | `"http"` | `"http"` | +| `createLocalTransport(server, ...)` | `"in-process"` | `"in-process"` | + +Detection is header-driven: `createLocalTransport` prepends an internal +`connectum-internal-transport: in-process` request header that both the +server and client interceptors observe. HTTP requests never carry that +header, so the default tag is `"http"`. + +### Parity guarantees + +Every observable surface (instrument names, units, label key sets, span +kinds, span events, status codes) is invariant across transports. A +dedicated parity suite under `packages/otel/tests/parity` runs each +scenario twice — once over HTTP/2 and once over the in-process pipe — +and asserts structural equivalence after stripping `connectum.transport` +and `transport`. Specifically: + +- `SpanKind.CLIENT` + `SpanKind.SERVER` spans are emitted on both paths. +- Streaming `rpc.message` events (`SENT` / `RECEIVED`) are produced with + identical sequence ids on both paths when `recordMessages: true`. +- Error spans share the same `rpc.connect_rpc.status_code`, `error.type`, + and `SpanStatusCode.ERROR` outcome. +- Metric instrument set is a subset of the HTTP set — no transport-only + instruments. +- W3C `traceparent` / `tracestate` propagation works in both directions: + with `trustRemote: true`, the server span is the child of the client + span on both paths. + +### Notes + +- `trustRemote: true` is recommended when using both transports + symmetrically. With the default `trustRemote: false`, HTTP server spans + attach the remote span as a *link* (no parent), while in-process + server spans inherit the active client context as their parent — + producing a parent-shape diff that is unrelated to the OTel surface. +- Payload-size histograms (`rpc.*.request.size`, `rpc.*.response.size`) + use the same `estimateMessageSize()` helper on both transports; values + may differ slightly between independent runs (timestamp drift) but the + instrument shape is identical. + +### Example + +```typescript +import { createServer, createLocalTransport } from '@connectum/core'; +import { createClient } from '@connectrpc/connect'; +import { createOtelInterceptor, createOtelClientInterceptor } from '@connectum/otel'; + +const server = createServer({ + services: [routes], + interceptors: [createOtelInterceptor({ serverAddress: 'svc', trustRemote: true })], +}); + +// In-process: identical telemetry to HTTP path, tagged `connectum.transport=in-process`. +const transport = createLocalTransport(server, { + interceptors: [createOtelClientInterceptor({ serverAddress: 'svc' })], +}); +const client = createClient(MyService, transport); +``` + ## Related Packages - **[@connectum/core](./core.md)** -- Server where the interceptor runs