@geekmidas/constructs 10.0.0-alpha.99 → 10.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +437 -0
- package/README.md +193 -285
- package/dist/AWSScheduledFunction-BzGCUbkk.d.mts +117 -0
- package/dist/AWSScheduledFunction-BzGCUbkk.d.mts.map +1 -0
- package/dist/AWSScheduledFunction-C42adp8A.cjs +266 -0
- package/dist/AWSScheduledFunction-C42adp8A.cjs.map +1 -0
- package/dist/AWSScheduledFunction-CsNJhXQj.d.cts +117 -0
- package/dist/AWSScheduledFunction-CsNJhXQj.d.cts.map +1 -0
- package/dist/AWSScheduledFunction-KP6lqbsW.mjs +254 -0
- package/dist/AWSScheduledFunction-KP6lqbsW.mjs.map +1 -0
- package/dist/{Construct-B1vGBPme.mjs → Construct-BWF5HxaM.mjs} +37 -47
- package/dist/Construct-BWF5HxaM.mjs.map +1 -0
- package/dist/Construct-JlyQkBkv.d.cts +117 -0
- package/dist/Construct-JlyQkBkv.d.cts.map +1 -0
- package/dist/{Construct-DUSXuTHP.cjs → Construct-TGIM_E4o.cjs} +88 -67
- package/dist/Construct-TGIM_E4o.cjs.map +1 -0
- package/dist/Construct-pxwC6fDD.d.mts +117 -0
- package/dist/Construct-pxwC6fDD.d.mts.map +1 -0
- package/dist/{Endpoint-Du-NwPX2.d.mts → Endpoint-B0P_pEMr.d.mts} +85 -126
- package/dist/Endpoint-B0P_pEMr.d.mts.map +1 -0
- package/dist/{Endpoint-aCvBMPoH.d.cts → Endpoint-BLZ7r67m.d.cts} +84 -125
- package/dist/Endpoint-BLZ7r67m.d.cts.map +1 -0
- package/dist/{HonoEndpointAdaptor-PtPlbeKY.mjs → HonoEndpointAdaptor-BMVwx2cz.mjs} +69 -81
- package/dist/HonoEndpointAdaptor-BMVwx2cz.mjs.map +1 -0
- package/dist/{HonoEndpointAdaptor-zVzVLJEO.cjs → HonoEndpointAdaptor-DPDsDi-D.cjs} +77 -92
- package/dist/HonoEndpointAdaptor-DPDsDi-D.cjs.map +1 -0
- package/dist/Queue-BL68oDJ-.d.mts +66 -0
- package/dist/Queue-BL68oDJ-.d.mts.map +1 -0
- package/dist/Queue-DxJ6btRE.d.cts +66 -0
- package/dist/Queue-DxJ6btRE.d.cts.map +1 -0
- package/dist/Subscriber-BpVhcGhX.d.cts +47 -0
- package/dist/Subscriber-BpVhcGhX.d.cts.map +1 -0
- package/dist/Subscriber-DF6xsBAJ.d.mts +47 -0
- package/dist/Subscriber-DF6xsBAJ.d.mts.map +1 -0
- package/dist/Topic-DJXoDeMP.d.cts +60 -0
- package/dist/Topic-DJXoDeMP.d.cts.map +1 -0
- package/dist/Topic-DxWQBgMN.d.mts +60 -0
- package/dist/Topic-DxWQBgMN.d.mts.map +1 -0
- package/dist/adaptors/aws.cjs +205 -355
- package/dist/adaptors/aws.cjs.map +1 -1
- package/dist/adaptors/aws.d.cts +48 -126
- package/dist/adaptors/aws.d.cts.map +1 -1
- package/dist/adaptors/aws.d.mts +49 -127
- package/dist/adaptors/aws.d.mts.map +1 -1
- package/dist/adaptors/aws.mjs +178 -325
- package/dist/adaptors/aws.mjs.map +1 -1
- package/dist/adaptors/hono.cjs +9 -3
- package/dist/adaptors/hono.d.cts +15 -7
- package/dist/adaptors/hono.d.cts.map +1 -1
- package/dist/adaptors/hono.d.mts +17 -9
- package/dist/adaptors/hono.d.mts.map +1 -1
- package/dist/adaptors/hono.mjs +9 -2
- package/dist/adaptors/testing.cjs +209 -831
- package/dist/adaptors/testing.cjs.map +1 -1
- package/dist/adaptors/testing.d.cts +55 -351
- package/dist/adaptors/testing.d.cts.map +1 -1
- package/dist/adaptors/testing.d.mts +53 -349
- package/dist/adaptors/testing.d.mts.map +1 -1
- package/dist/adaptors/testing.mjs +195 -798
- package/dist/adaptors/testing.mjs.map +1 -1
- package/dist/{clone-UGJpvQnL.cjs → clone-I_WIpiFf.cjs} +8 -7
- package/dist/clone-I_WIpiFf.cjs.map +1 -0
- package/dist/{clone-EKNovYHu.mjs → clone-pdXxc0t3.mjs} +3 -3
- package/dist/clone-pdXxc0t3.mjs.map +1 -0
- package/dist/crons/index.cjs +66 -190
- package/dist/crons/index.cjs.map +1 -1
- package/dist/crons/index.d.cts +35 -70
- package/dist/crons/index.d.cts.map +1 -1
- package/dist/crons/index.d.mts +32 -70
- package/dist/crons/index.d.mts.map +1 -1
- package/dist/crons/index.mjs +63 -184
- package/dist/crons/index.mjs.map +1 -1
- package/dist/endpoints/index.cjs +761 -19
- package/dist/endpoints/index.cjs.map +1 -0
- package/dist/endpoints/index.d.cts +322 -22
- package/dist/endpoints/index.d.cts.map +1 -1
- package/dist/endpoints/index.d.mts +321 -22
- package/dist/endpoints/index.d.mts.map +1 -1
- package/dist/endpoints/index.mjs +751 -6
- package/dist/endpoints/index.mjs.map +1 -0
- package/dist/functions/index.cjs +5 -2
- package/dist/functions/index.d.cts +3 -3
- package/dist/functions/index.d.mts +3 -3
- package/dist/functions/index.mjs +5 -2
- package/dist/{functions-BFizikJU.mjs → functions-EqTloHjo.mjs} +331 -425
- package/dist/functions-EqTloHjo.mjs.map +1 -0
- package/dist/{functions-CfzJG9hK.cjs → functions-SqtCDc9c.cjs} +370 -459
- package/dist/functions-SqtCDc9c.cjs.map +1 -0
- package/dist/index-C7iynzLI.d.mts +139 -0
- package/dist/index-C7iynzLI.d.mts.map +1 -0
- package/dist/index-D4dM_WDY.d.cts +142 -0
- package/dist/index-D4dM_WDY.d.cts.map +1 -0
- package/dist/index.cjs +3 -6
- package/dist/index.d.cts +4 -27
- package/dist/index.d.mts +4 -27
- package/dist/index.mjs +3 -3
- package/dist/{Endpoint-BG4UJ9oA.mjs → lazyAccessors-CCTK19xj.mjs} +1040 -914
- package/dist/lazyAccessors-CCTK19xj.mjs.map +1 -0
- package/dist/{Endpoint-BoUg8ocM.cjs → lazyAccessors-D04oftGw.cjs} +1127 -960
- package/dist/lazyAccessors-D04oftGw.cjs.map +1 -0
- package/dist/monitors/index.cjs +49 -0
- package/dist/monitors/index.cjs.map +1 -0
- package/dist/monitors/index.d.cts +45 -0
- package/dist/monitors/index.d.cts.map +1 -0
- package/dist/monitors/index.d.mts +45 -0
- package/dist/monitors/index.d.mts.map +1 -0
- package/dist/monitors/index.mjs +48 -0
- package/dist/monitors/index.mjs.map +1 -0
- package/dist/processAudits-BJZT5gmy.cjs +92 -0
- package/dist/processAudits-BJZT5gmy.cjs.map +1 -0
- package/dist/processAudits-CwyaaSQc.mjs +80 -0
- package/dist/processAudits-CwyaaSQc.mjs.map +1 -0
- package/dist/publisher-BZgcrVPy.cjs +53 -0
- package/dist/publisher-BZgcrVPy.cjs.map +1 -0
- package/dist/publisher-CnpeMv-r.mjs +41 -0
- package/dist/publisher-CnpeMv-r.mjs.map +1 -0
- package/dist/queue/index.cjs +114 -6
- package/dist/queue/index.cjs.map +1 -0
- package/dist/queue/index.d.cts +45 -3
- package/dist/queue/index.d.cts.map +1 -0
- package/dist/queue/index.d.mts +44 -3
- package/dist/queue/index.d.mts.map +1 -0
- package/dist/queue/index.mjs +112 -3
- package/dist/queue/index.mjs.map +1 -0
- package/dist/subscribers/index.cjs +80 -111
- package/dist/subscribers/index.cjs.map +1 -1
- package/dist/subscribers/index.d.cts +43 -46
- package/dist/subscribers/index.d.cts.map +1 -1
- package/dist/subscribers/index.d.mts +42 -46
- package/dist/subscribers/index.d.mts.map +1 -1
- package/dist/subscribers/index.mjs +78 -108
- package/dist/subscribers/index.mjs.map +1 -1
- package/dist/{lambdaTelemetry-8vnmVZQ5.d.cts → telemetry-C--EgYVr.d.mts} +7 -4
- package/dist/telemetry-C--EgYVr.d.mts.map +1 -0
- package/dist/{lambdaTelemetry-8vnmVZQ5.d.mts → telemetry-Dqx-D3F7.d.cts} +7 -4
- package/dist/telemetry-Dqx-D3F7.d.cts.map +1 -0
- package/dist/topic/index.cjs +91 -3
- package/dist/topic/index.cjs.map +1 -0
- package/dist/topic/index.d.cts +32 -2
- package/dist/topic/index.d.cts.map +1 -0
- package/dist/topic/index.d.mts +32 -2
- package/dist/topic/index.d.mts.map +1 -0
- package/dist/topic/index.mjs +89 -2
- package/dist/topic/index.mjs.map +1 -0
- package/dist/{types-DMuSQeLL.d.cts → types-BdAaYDvd.d.cts} +5 -3
- package/dist/types-BdAaYDvd.d.cts.map +1 -0
- package/dist/{types-DMuSQeLL.d.mts → types-DNngH0fX.d.mts} +5 -3
- package/dist/types-DNngH0fX.d.mts.map +1 -0
- package/dist/types.d.cts +1 -1
- package/dist/types.d.mts +1 -1
- package/dist/types.mjs +0 -1
- package/package.json +55 -223
- package/src/Construct.ts +209 -0
- package/src/__benchmarks__/build-time-optimization.bench.ts +274 -0
- package/src/__benchmarks__/endpoint.bench.ts +494 -0
- package/src/__benchmarks__/fixtures.ts +241 -0
- package/src/__benchmarks__/hono-adaptor.bench.ts +533 -0
- package/src/__benchmarks__/hono-server.bench.ts +249 -0
- package/src/__benchmarks__/response-builder.bench.ts +428 -0
- package/src/__benchmarks__/strategies/strategy-a-lazy-services.ts +319 -0
- package/src/__benchmarks__/strategies/strategy-c-middleware.ts +530 -0
- package/src/__benchmarks__/strategies/strategy-d-opt-in-events.ts +567 -0
- package/src/__tests__/Construct.environment.spec.ts +704 -0
- package/src/__tests__/builder-reuse.spec.ts +587 -0
- package/src/__tests__/monitor.spec.ts +636 -0
- package/src/__tests__/publisher.setting.spec.ts +508 -0
- package/src/__tests__/publisher.spec.ts +452 -0
- package/src/adaptors/aws.ts +6 -0
- package/src/adaptors/hono.ts +1 -0
- package/src/adaptors/testing.ts +11 -0
- package/src/clone.ts +38 -0
- package/src/crons/AWSScheduledFunction.ts +73 -0
- package/src/crons/Cron.ts +149 -0
- package/src/crons/CronBuilder.ts +261 -0
- package/src/crons/__tests__/AWSScheduledFunction.spec.ts +152 -0
- package/src/crons/__tests__/Cron.spec.ts +472 -0
- package/src/crons/__tests__/CronBuilder.state-isolation.spec.ts +273 -0
- package/src/crons/index.ts +12 -0
- package/src/endpoints/AmazonApiGatewayEndpointAdaptor.ts +698 -0
- package/src/endpoints/AmazonApiGatewayV1EndpointAdaptor.ts +105 -0
- package/src/endpoints/AmazonApiGatewayV2EndpointAdaptor.ts +97 -0
- package/src/endpoints/Authorizer.ts +152 -0
- package/src/endpoints/Endpoint.ts +1287 -0
- package/src/endpoints/EndpointBuilder.ts +749 -0
- package/src/endpoints/EndpointFactory.ts +1179 -0
- package/src/endpoints/HonoEndpointAdaptor.ts +692 -0
- package/src/endpoints/MswEndpointAdaptor.ts +226 -0
- package/src/endpoints/TestEndpointAdaptor.ts +466 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV1EndpointAdaptor.audits.spec.ts +499 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV1EndpointAdaptor.events.spec.ts +560 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV1EndpointAdaptor.spec.ts +1304 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.audits.spec.ts +626 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.events.spec.ts +732 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.factory-publisher.spec.ts +296 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.kysely-audit.integration.spec.ts +951 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.responseType.spec.ts +111 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.rls.spec.ts +307 -0
- package/src/endpoints/__tests__/AmazonApiGatewayV2EndpointAdaptor.spec.ts +629 -0
- package/src/endpoints/__tests__/Authorizer.spec.ts +286 -0
- package/src/endpoints/__tests__/Endpoint.cookies.spec.ts +207 -0
- package/src/endpoints/__tests__/Endpoint.headers.spec.ts +187 -0
- package/src/endpoints/__tests__/Endpoint.manifest.spec.ts +175 -0
- package/src/endpoints/__tests__/Endpoint.spec.ts +857 -0
- package/src/endpoints/__tests__/EndpointBuilder.audit.spec.ts +451 -0
- package/src/endpoints/__tests__/EndpointBuilder.responseType.spec.ts +50 -0
- package/src/endpoints/__tests__/EndpointBuilder.spec.ts +531 -0
- package/src/endpoints/__tests__/EndpointFactory.authorizers.spec.ts +492 -0
- package/src/endpoints/__tests__/EndpointFactory.database-auditor.spec.ts +509 -0
- package/src/endpoints/__tests__/EndpointFactory.reference-audit.spec.ts +190 -0
- package/src/endpoints/__tests__/EndpointFactory.spec.ts +479 -0
- package/src/endpoints/__tests__/EndpointFactory.state-isolation.spec.ts +155 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.audit-transactions.spec.ts +703 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.audits.spec.ts +632 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.events.spec.ts +577 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.kysely-audit.integration.spec.ts +1067 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.openapi.spec.ts +317 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.pgboss-publisher.spec.ts +289 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.responseType.spec.ts +128 -0
- package/src/endpoints/__tests__/HonoEndpointAdaptor.spec.ts +1207 -0
- package/src/endpoints/__tests__/MswEndpointAdaptor.spec.ts +211 -0
- package/src/endpoints/__tests__/ResponseBuilder.spec.ts +235 -0
- package/src/endpoints/__tests__/TestEndpointAdaptor.audits.spec.ts +602 -0
- package/src/endpoints/__tests__/TestEndpointAdaptor.spec.ts +1044 -0
- package/src/endpoints/__tests__/__snapshots__/HonoEndpointAdaptor.spec.ts.snap +54 -0
- package/src/endpoints/__tests__/endpoint-types.test.ts +88 -0
- package/src/endpoints/__tests__/helpers.spec.ts +37 -0
- package/src/endpoints/__tests__/lazyAccessors.spec.ts +330 -0
- package/src/endpoints/__tests__/processAudits.spec.ts +631 -0
- package/src/endpoints/audit.ts +87 -0
- package/src/endpoints/helpers.ts +98 -0
- package/src/endpoints/index.ts +42 -0
- package/src/endpoints/lazyAccessors.ts +241 -0
- package/src/endpoints/parseHonoQuery.ts +16 -0
- package/src/endpoints/parseQueryParams.ts +32 -0
- package/src/endpoints/processAudits.ts +371 -0
- package/src/endpoints/rls.ts +67 -0
- package/src/functions/AWSLambdaFunction.ts +374 -0
- package/src/functions/BaseFunctionBuilder.ts +212 -0
- package/src/functions/Function.ts +238 -0
- package/src/functions/FunctionBuilder.ts +381 -0
- package/src/functions/FunctionExecutionWrapper.ts +216 -0
- package/src/functions/TestFunctionAdaptor.ts +252 -0
- package/src/functions/__tests__/AWSLambdaFunctionAdaptor.spec.ts +513 -0
- package/src/functions/__tests__/Function.audits.spec.ts +393 -0
- package/src/functions/__tests__/Function.spec.ts +477 -0
- package/src/functions/__tests__/FunctionBuilder.state-isolation.spec.ts +250 -0
- package/src/functions/__tests__/TestFunctionAdaptor.spec.ts +480 -0
- package/src/functions/index.ts +12 -0
- package/src/index.ts +29 -0
- package/src/monitor.ts +145 -0
- package/src/monitors/heartbeat.ts +86 -0
- package/src/monitors/index.ts +6 -0
- package/src/publisher.ts +93 -0
- package/src/queue/AWSLambdaQueueAdaptor.ts +162 -0
- package/src/queue/Queue.ts +128 -0
- package/src/queue/QueueBuilder.ts +115 -0
- package/src/queue/TestQueueAdaptor.ts +63 -0
- package/src/queue/__tests__/QueueBuilder.spec.ts +137 -0
- package/src/queue/index.ts +12 -0
- package/src/subscribers/AWSLambdaSubscriberAdaptor.ts +342 -0
- package/src/subscribers/Subscriber.ts +117 -0
- package/src/subscribers/SubscriberBuilder.ts +183 -0
- package/src/subscribers/TestSubscriberAdaptor.ts +133 -0
- package/src/subscribers/__tests__/AWSLambdaSubscriberAdaptor.spec.ts +1018 -0
- package/src/subscribers/__tests__/Subscriber.spec.ts +430 -0
- package/src/subscribers/__tests__/TestSubscriberAdaptor.spec.ts +652 -0
- package/src/subscribers/index.ts +6 -0
- package/src/telemetry.ts +103 -0
- package/src/topic/Topic.ts +103 -0
- package/src/topic/TopicBuilder.ts +53 -0
- package/src/topic/__tests__/TopicBuilder.spec.ts +82 -0
- package/src/topic/index.ts +11 -0
- package/src/types.ts +13 -0
- package/test.ts +91 -0
- package/tsconfig.json +9 -0
- package/tsdown.config.ts +35 -0
- package/dist/Construct-B1vGBPme.mjs.map +0 -1
- package/dist/Construct-BQALFCh2.d.cts +0 -230
- package/dist/Construct-BQALFCh2.d.cts.map +0 -1
- package/dist/Construct-DUSXuTHP.cjs.map +0 -1
- package/dist/Construct-QXnl3VqT.d.mts +0 -230
- package/dist/Construct-QXnl3VqT.d.mts.map +0 -1
- package/dist/Cron-DI3nKoic.d.cts +0 -45
- package/dist/Cron-DI3nKoic.d.cts.map +0 -1
- package/dist/Cron-uYAHPnp7.d.mts +0 -45
- package/dist/Cron-uYAHPnp7.d.mts.map +0 -1
- package/dist/CronBuilder-C0Ek1-RA.cjs +0 -121
- package/dist/CronBuilder-C0Ek1-RA.cjs.map +0 -1
- package/dist/CronBuilder-DaSUm2Na.d.mts +0 -47
- package/dist/CronBuilder-DaSUm2Na.d.mts.map +0 -1
- package/dist/CronBuilder-Dmix_Pen.mjs +0 -109
- package/dist/CronBuilder-Dmix_Pen.mjs.map +0 -1
- package/dist/CronBuilder-g1lZLWyG.d.cts +0 -47
- package/dist/CronBuilder-g1lZLWyG.d.cts.map +0 -1
- package/dist/Endpoint-BG4UJ9oA.mjs.map +0 -1
- package/dist/Endpoint-BoUg8ocM.cjs.map +0 -1
- package/dist/Endpoint-Du-NwPX2.d.mts.map +0 -1
- package/dist/Endpoint-aCvBMPoH.d.cts.map +0 -1
- package/dist/EndpointFactory-BDtsrEvJ.mjs +0 -791
- package/dist/EndpointFactory-BDtsrEvJ.mjs.map +0 -1
- package/dist/EndpointFactory-DJ7gXLpR.cjs +0 -833
- package/dist/EndpointFactory-DJ7gXLpR.cjs.map +0 -1
- package/dist/EndpointFactory-DMYdJCOj.d.mts +0 -363
- package/dist/EndpointFactory-DMYdJCOj.d.mts.map +0 -1
- package/dist/EndpointFactory-I7s1co3Y.d.cts +0 -363
- package/dist/EndpointFactory-I7s1co3Y.d.cts.map +0 -1
- package/dist/Function-DuqGcbOI.d.mts +0 -76
- package/dist/Function-DuqGcbOI.d.mts.map +0 -1
- package/dist/Function-Pu-1kKZz.d.cts +0 -76
- package/dist/Function-Pu-1kKZz.d.cts.map +0 -1
- package/dist/HonoEndpointAdaptor-PtPlbeKY.mjs.map +0 -1
- package/dist/HonoEndpointAdaptor-zVzVLJEO.cjs.map +0 -1
- package/dist/Queue-A3wfD0it.cjs +0 -109
- package/dist/Queue-A3wfD0it.cjs.map +0 -1
- package/dist/Queue-D6USGS4q.mjs +0 -104
- package/dist/Queue-D6USGS4q.mjs.map +0 -1
- package/dist/Queue-DlsHRzUp.d.mts +0 -105
- package/dist/Queue-DlsHRzUp.d.mts.map +0 -1
- package/dist/Queue-HPyi0e1i.d.cts +0 -105
- package/dist/Queue-HPyi0e1i.d.cts.map +0 -1
- package/dist/QueueBuilder-BjuF0UBl.cjs +0 -135
- package/dist/QueueBuilder-BjuF0UBl.cjs.map +0 -1
- package/dist/QueueBuilder-Cue73M4t.mjs +0 -118
- package/dist/QueueBuilder-Cue73M4t.mjs.map +0 -1
- package/dist/QueueBuilder-OSi6LkV9.d.cts +0 -75
- package/dist/QueueBuilder-OSi6LkV9.d.cts.map +0 -1
- package/dist/QueueBuilder-QHsnVt1P.d.mts +0 -75
- package/dist/QueueBuilder-QHsnVt1P.d.mts.map +0 -1
- package/dist/Subscriber-Bpp02cGr.d.cts +0 -61
- package/dist/Subscriber-Bpp02cGr.d.cts.map +0 -1
- package/dist/Subscriber-CtN9R48-.d.mts +0 -61
- package/dist/Subscriber-CtN9R48-.d.mts.map +0 -1
- package/dist/SubscriberBuilder-CDy4nHCz.mjs +0 -134
- package/dist/SubscriberBuilder-CDy4nHCz.mjs.map +0 -1
- package/dist/SubscriberBuilder-CuCMFpYW.d.mts +0 -67
- package/dist/SubscriberBuilder-CuCMFpYW.d.mts.map +0 -1
- package/dist/SubscriberBuilder-D_owVoHo.cjs +0 -145
- package/dist/SubscriberBuilder-D_owVoHo.cjs.map +0 -1
- package/dist/SubscriberBuilder-g3fAVWgs.d.cts +0 -67
- package/dist/SubscriberBuilder-g3fAVWgs.d.cts.map +0 -1
- package/dist/Topic-D74b5cgs.mjs +0 -99
- package/dist/Topic-D74b5cgs.mjs.map +0 -1
- package/dist/Topic-GHxcU8AG.cjs +0 -104
- package/dist/Topic-GHxcU8AG.cjs.map +0 -1
- package/dist/auth-BMCJN30Y.d.cts +0 -268
- package/dist/auth-BMCJN30Y.d.cts.map +0 -1
- package/dist/auth-CcuceLYo.d.mts +0 -268
- package/dist/auth-CcuceLYo.d.mts.map +0 -1
- package/dist/auth.cjs +0 -433
- package/dist/auth.cjs.map +0 -1
- package/dist/auth.d.cts +0 -2
- package/dist/auth.d.mts +0 -2
- package/dist/auth.mjs +0 -426
- package/dist/auth.mjs.map +0 -1
- package/dist/cache-CXh6GIgb.d.mts +0 -44
- package/dist/cache-CXh6GIgb.d.mts.map +0 -1
- package/dist/cache-DnGDGly3.d.cts +0 -44
- package/dist/cache-DnGDGly3.d.cts.map +0 -1
- package/dist/cache.cjs +0 -69
- package/dist/cache.cjs.map +0 -1
- package/dist/cache.d.cts +0 -2
- package/dist/cache.d.mts +0 -2
- package/dist/cache.mjs +0 -68
- package/dist/cache.mjs.map +0 -1
- package/dist/cipher-C1lEFX63.mjs +0 -225
- package/dist/cipher-C1lEFX63.mjs.map +0 -1
- package/dist/cipher-CVxfwLjk.cjs +0 -332
- package/dist/cipher-CVxfwLjk.cjs.map +0 -1
- package/dist/clone-EKNovYHu.mjs.map +0 -1
- package/dist/clone-UGJpvQnL.cjs.map +0 -1
- package/dist/construct-interface-B1AfqRl4.d.cts +0 -162
- package/dist/construct-interface-B1AfqRl4.d.cts.map +0 -1
- package/dist/construct-interface-DluK3_da.d.mts +0 -162
- package/dist/construct-interface-DluK3_da.d.mts.map +0 -1
- package/dist/construct-interface.cjs +0 -114
- package/dist/construct-interface.cjs.map +0 -1
- package/dist/construct-interface.d.cts +0 -2
- package/dist/construct-interface.d.mts +0 -2
- package/dist/construct-interface.mjs +0 -107
- package/dist/construct-interface.mjs.map +0 -1
- package/dist/credential.cjs +0 -156
- package/dist/credential.cjs.map +0 -1
- package/dist/credential.d.cts +0 -86
- package/dist/credential.d.cts.map +0 -1
- package/dist/credential.d.mts +0 -86
- package/dist/credential.d.mts.map +0 -1
- package/dist/credential.mjs +0 -152
- package/dist/credential.mjs.map +0 -1
- package/dist/database/kysely.cjs +0 -4
- package/dist/database/kysely.d.cts +0 -2
- package/dist/database/kysely.d.mts +0 -2
- package/dist/database/kysely.mjs +0 -2
- package/dist/email.cjs +0 -72
- package/dist/email.cjs.map +0 -1
- package/dist/email.d.cts +0 -46
- package/dist/email.d.cts.map +0 -1
- package/dist/email.d.mts +0 -46
- package/dist/email.d.mts.map +0 -1
- package/dist/email.mjs +0 -71
- package/dist/email.mjs.map +0 -1
- package/dist/encryption.cjs +0 -96
- package/dist/encryption.cjs.map +0 -1
- package/dist/encryption.d.cts +0 -117
- package/dist/encryption.d.cts.map +0 -1
- package/dist/encryption.d.mts +0 -117
- package/dist/encryption.d.mts.map +0 -1
- package/dist/encryption.mjs +0 -83
- package/dist/encryption.mjs.map +0 -1
- package/dist/external-api-MJ8id87V.d.mts +0 -105
- package/dist/external-api-MJ8id87V.d.mts.map +0 -1
- package/dist/external-api-O107yzZJ.d.cts +0 -105
- package/dist/external-api-O107yzZJ.d.cts.map +0 -1
- package/dist/external-api.cjs +0 -142
- package/dist/external-api.cjs.map +0 -1
- package/dist/external-api.d.cts +0 -2
- package/dist/external-api.d.mts +0 -2
- package/dist/external-api.mjs +0 -139
- package/dist/external-api.mjs.map +0 -1
- package/dist/file-server.cjs +0 -186
- package/dist/file-server.cjs.map +0 -1
- package/dist/file-server.d.cts +0 -152
- package/dist/file-server.d.cts.map +0 -1
- package/dist/file-server.d.mts +0 -152
- package/dist/file-server.d.mts.map +0 -1
- package/dist/file-server.mjs +0 -184
- package/dist/file-server.mjs.map +0 -1
- package/dist/functions-BFizikJU.mjs.map +0 -1
- package/dist/functions-CfzJG9hK.cjs.map +0 -1
- package/dist/index-BuzRvKOQ.d.cts +0 -115
- package/dist/index-BuzRvKOQ.d.cts.map +0 -1
- package/dist/index-CTkKOer4.d.mts +0 -115
- package/dist/index-CTkKOer4.d.mts.map +0 -1
- package/dist/index-CeEtxDmK.d.cts +0 -79
- package/dist/index-CeEtxDmK.d.cts.map +0 -1
- package/dist/index-CeEtxDmK.d.mts +0 -79
- package/dist/index-CeEtxDmK.d.mts.map +0 -1
- package/dist/index.d.cts.map +0 -1
- package/dist/index.d.mts.map +0 -1
- package/dist/kms-B-Hm3d5r.cjs +0 -85
- package/dist/kms-B-Hm3d5r.cjs.map +0 -1
- package/dist/kms-BdUlMJEZ.mjs +0 -85
- package/dist/kms-BdUlMJEZ.mjs.map +0 -1
- package/dist/kysely-Bii4l6eP.mjs +0 -370
- package/dist/kysely-Bii4l6eP.mjs.map +0 -1
- package/dist/kysely-CO_Dk43W.cjs +0 -383
- package/dist/kysely-CO_Dk43W.cjs.map +0 -1
- package/dist/kysely-D0bpzgPs.d.cts +0 -175
- package/dist/kysely-D0bpzgPs.d.cts.map +0 -1
- package/dist/kysely-DUqC3Ie0.d.mts +0 -175
- package/dist/kysely-DUqC3Ie0.d.mts.map +0 -1
- package/dist/lambdaTelemetry-8vnmVZQ5.d.cts.map +0 -1
- package/dist/lambdaTelemetry-8vnmVZQ5.d.mts.map +0 -1
- package/dist/lazyAccessors-CFanua0O.mjs +0 -174
- package/dist/lazyAccessors-CFanua0O.mjs.map +0 -1
- package/dist/lazyAccessors-hJKGv8Ay.cjs +0 -221
- package/dist/lazyAccessors-hJKGv8Ay.cjs.map +0 -1
- package/dist/mobile-app.cjs +0 -73
- package/dist/mobile-app.cjs.map +0 -1
- package/dist/mobile-app.d.cts +0 -61
- package/dist/mobile-app.d.cts.map +0 -1
- package/dist/mobile-app.d.mts +0 -61
- package/dist/mobile-app.d.mts.map +0 -1
- package/dist/mobile-app.mjs +0 -72
- package/dist/mobile-app.mjs.map +0 -1
- package/dist/object-storage.cjs +0 -56
- package/dist/object-storage.cjs.map +0 -1
- package/dist/object-storage.d.cts +0 -32
- package/dist/object-storage.d.cts.map +0 -1
- package/dist/object-storage.d.mts +0 -32
- package/dist/object-storage.d.mts.map +0 -1
- package/dist/object-storage.mjs +0 -55
- package/dist/object-storage.mjs.map +0 -1
- package/dist/processAudits-BRRVVHUB.mjs +0 -131
- package/dist/processAudits-BRRVVHUB.mjs.map +0 -1
- package/dist/processAudits-DasOZjPl.cjs +0 -154
- package/dist/processAudits-DasOZjPl.cjs.map +0 -1
- package/dist/rest-api.cjs +0 -216
- package/dist/rest-api.cjs.map +0 -1
- package/dist/rest-api.d.cts +0 -241
- package/dist/rest-api.d.cts.map +0 -1
- package/dist/rest-api.d.mts +0 -241
- package/dist/rest-api.d.mts.map +0 -1
- package/dist/rest-api.mjs +0 -215
- package/dist/rest-api.mjs.map +0 -1
- package/dist/rolldown-runtime-y5ARvAq5.cjs +0 -35
- package/dist/runSubscriber-BHvJ8POr.mjs +0 -109
- package/dist/runSubscriber-BHvJ8POr.mjs.map +0 -1
- package/dist/runSubscriber-D8nLXIv1.cjs +0 -126
- package/dist/runSubscriber-D8nLXIv1.cjs.map +0 -1
- package/dist/shutdown-BMJmAhSt.cjs +0 -38
- package/dist/shutdown-BMJmAhSt.cjs.map +0 -1
- package/dist/shutdown-C7xa8x9S.mjs +0 -27
- package/dist/shutdown-C7xa8x9S.mjs.map +0 -1
- package/dist/site.cjs +0 -74
- package/dist/site.cjs.map +0 -1
- package/dist/site.d.cts +0 -104
- package/dist/site.d.cts.map +0 -1
- package/dist/site.d.mts +0 -104
- package/dist/site.d.mts.map +0 -1
- package/dist/site.mjs +0 -73
- package/dist/site.mjs.map +0 -1
- package/dist/stages-BSCF19o2.d.cts +0 -56
- package/dist/stages-BSCF19o2.d.cts.map +0 -1
- package/dist/stages-BSCF19o2.d.mts +0 -56
- package/dist/stages-BSCF19o2.d.mts.map +0 -1
- package/dist/surfaceEnv-CNimK76p.cjs +0 -56
- package/dist/surfaceEnv-CNimK76p.cjs.map +0 -1
- package/dist/surfaceEnv-wMT5QzgZ.mjs +0 -45
- package/dist/surfaceEnv-wMT5QzgZ.mjs.map +0 -1
- package/dist/telemetry-B48RLjyk.d.cts +0 -40
- package/dist/telemetry-B48RLjyk.d.cts.map +0 -1
- package/dist/telemetry-DRtT1_0A.d.mts +0 -40
- package/dist/telemetry-DRtT1_0A.d.mts.map +0 -1
- package/dist/telemetry.cjs +0 -56
- package/dist/telemetry.cjs.map +0 -1
- package/dist/telemetry.d.cts +0 -2
- package/dist/telemetry.d.mts +0 -2
- package/dist/telemetry.mjs +0 -55
- package/dist/telemetry.mjs.map +0 -1
- package/dist/tracing-CxaZ98IB.mjs +0 -110
- package/dist/tracing-CxaZ98IB.mjs.map +0 -1
- package/dist/tracing-DPMidF_r.cjs +0 -127
- package/dist/tracing-DPMidF_r.cjs.map +0 -1
- package/dist/types-DMuSQeLL.d.cts.map +0 -1
- package/dist/types-DMuSQeLL.d.mts.map +0 -1
- package/dist/worker.cjs +0 -191
- package/dist/worker.cjs.map +0 -1
- package/dist/worker.d.cts +0 -171
- package/dist/worker.d.cts.map +0 -1
- package/dist/worker.d.mts +0 -171
- package/dist/worker.d.mts.map +0 -1
- package/dist/worker.mjs +0 -190
- package/dist/worker.mjs.map +0 -1
|
@@ -0,0 +1,317 @@
|
|
|
1
|
+
import type { EnvironmentParser } from '@geekmidas/envkit';
|
|
2
|
+
import type { Logger } from '@geekmidas/logger';
|
|
3
|
+
import { Hono } from 'hono';
|
|
4
|
+
import { describe, expect, it } from 'vitest';
|
|
5
|
+
import { z } from 'zod/v4';
|
|
6
|
+
import { Endpoint, e } from '../';
|
|
7
|
+
|
|
8
|
+
import { HonoEndpoint } from '../HonoEndpointAdaptor';
|
|
9
|
+
|
|
10
|
+
describe('HonoEndpoint OpenAPI Documentation', () => {
|
|
11
|
+
const logger = {
|
|
12
|
+
child: () => logger,
|
|
13
|
+
info: () => {},
|
|
14
|
+
error: () => {},
|
|
15
|
+
warn: () => {},
|
|
16
|
+
debug: () => {},
|
|
17
|
+
} as unknown as Logger;
|
|
18
|
+
const _mockEnvParser = {} as EnvironmentParser<{}>;
|
|
19
|
+
|
|
20
|
+
it('should generate OpenAPI documentation at /docs by default', async () => {
|
|
21
|
+
// Create test endpoints
|
|
22
|
+
const getUserEndpoint = new Endpoint({
|
|
23
|
+
route: '/users/:id',
|
|
24
|
+
method: 'GET',
|
|
25
|
+
fn: async ({ params }) => ({ id: params.id, name: 'John Doe' }),
|
|
26
|
+
input: {
|
|
27
|
+
params: z.object({
|
|
28
|
+
id: z.string().describe('User ID'),
|
|
29
|
+
}),
|
|
30
|
+
},
|
|
31
|
+
output: z.object({
|
|
32
|
+
id: z.string(),
|
|
33
|
+
name: z.string(),
|
|
34
|
+
}),
|
|
35
|
+
description: 'Get user by ID',
|
|
36
|
+
services: [],
|
|
37
|
+
logger,
|
|
38
|
+
timeout: undefined,
|
|
39
|
+
memorySize: undefined,
|
|
40
|
+
authorize: undefined,
|
|
41
|
+
getSession: undefined,
|
|
42
|
+
status: undefined,
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
const createUserEndpoint = e
|
|
46
|
+
.post('/users')
|
|
47
|
+
.description('Create a new user')
|
|
48
|
+
.body(
|
|
49
|
+
z.object({
|
|
50
|
+
name: z.string().describe('User name'),
|
|
51
|
+
}),
|
|
52
|
+
)
|
|
53
|
+
.output(
|
|
54
|
+
z.object({
|
|
55
|
+
id: z.string(),
|
|
56
|
+
name: z.string(),
|
|
57
|
+
}),
|
|
58
|
+
)
|
|
59
|
+
.handle(({ body }) => ({ id: '123', name: body.name }));
|
|
60
|
+
|
|
61
|
+
const endpoints = [getUserEndpoint, createUserEndpoint] as Endpoint<
|
|
62
|
+
any,
|
|
63
|
+
any,
|
|
64
|
+
any,
|
|
65
|
+
any,
|
|
66
|
+
any,
|
|
67
|
+
any,
|
|
68
|
+
any
|
|
69
|
+
>[];
|
|
70
|
+
|
|
71
|
+
const app = new Hono();
|
|
72
|
+
|
|
73
|
+
// Manually add routes for testing
|
|
74
|
+
HonoEndpoint.addRoutes(
|
|
75
|
+
endpoints,
|
|
76
|
+
{ register: async () => ({}) } as any,
|
|
77
|
+
app,
|
|
78
|
+
);
|
|
79
|
+
|
|
80
|
+
// Test the docs endpoint
|
|
81
|
+
const response = await app.request('/docs');
|
|
82
|
+
expect(response.status).toBe(200);
|
|
83
|
+
|
|
84
|
+
const openApiSchema = await response.json();
|
|
85
|
+
expect(openApiSchema).toMatchObject({
|
|
86
|
+
openapi: '3.0.0',
|
|
87
|
+
info: {
|
|
88
|
+
title: 'API',
|
|
89
|
+
version: '1.0.0',
|
|
90
|
+
},
|
|
91
|
+
paths: {
|
|
92
|
+
'/users/{id}': {
|
|
93
|
+
parameters: [
|
|
94
|
+
{
|
|
95
|
+
name: 'id',
|
|
96
|
+
in: 'path',
|
|
97
|
+
required: true,
|
|
98
|
+
schema: expect.objectContaining({
|
|
99
|
+
type: 'string',
|
|
100
|
+
description: 'User ID',
|
|
101
|
+
}),
|
|
102
|
+
},
|
|
103
|
+
],
|
|
104
|
+
get: {
|
|
105
|
+
description: 'Get user by ID',
|
|
106
|
+
responses: {
|
|
107
|
+
'200': expect.objectContaining({
|
|
108
|
+
description: 'Successful response',
|
|
109
|
+
}),
|
|
110
|
+
},
|
|
111
|
+
},
|
|
112
|
+
},
|
|
113
|
+
'/users': {
|
|
114
|
+
post: {
|
|
115
|
+
description: 'Create a new user',
|
|
116
|
+
requestBody: {
|
|
117
|
+
required: true,
|
|
118
|
+
content: {
|
|
119
|
+
'application/json': {
|
|
120
|
+
schema: expect.any(Object),
|
|
121
|
+
},
|
|
122
|
+
},
|
|
123
|
+
},
|
|
124
|
+
responses: {
|
|
125
|
+
'200': expect.objectContaining({
|
|
126
|
+
description: 'Successful response',
|
|
127
|
+
}),
|
|
128
|
+
},
|
|
129
|
+
},
|
|
130
|
+
},
|
|
131
|
+
},
|
|
132
|
+
});
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
it('should allow custom docs path', async () => {
|
|
136
|
+
const endpoint = new Endpoint({
|
|
137
|
+
route: '/test',
|
|
138
|
+
method: 'GET',
|
|
139
|
+
fn: async () => ({ message: 'test' }),
|
|
140
|
+
output: z.object({ message: z.string() }),
|
|
141
|
+
services: [],
|
|
142
|
+
logger,
|
|
143
|
+
timeout: undefined,
|
|
144
|
+
memorySize: undefined,
|
|
145
|
+
authorize: undefined,
|
|
146
|
+
getSession: undefined,
|
|
147
|
+
status: undefined,
|
|
148
|
+
description: undefined,
|
|
149
|
+
input: undefined,
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
const endpoints = [endpoint] as Endpoint<
|
|
153
|
+
any,
|
|
154
|
+
any,
|
|
155
|
+
any,
|
|
156
|
+
any,
|
|
157
|
+
any,
|
|
158
|
+
any,
|
|
159
|
+
any
|
|
160
|
+
>[];
|
|
161
|
+
|
|
162
|
+
const app = new Hono();
|
|
163
|
+
HonoEndpoint.addRoutes(
|
|
164
|
+
endpoints,
|
|
165
|
+
{ register: async () => ({}) } as any,
|
|
166
|
+
app,
|
|
167
|
+
{ docsPath: '/api-docs' },
|
|
168
|
+
);
|
|
169
|
+
|
|
170
|
+
const response = await app.request('/api-docs');
|
|
171
|
+
expect(response.status).toBe(200);
|
|
172
|
+
|
|
173
|
+
const openApiSchema = await response.json();
|
|
174
|
+
expect(openApiSchema.paths).toHaveProperty('/test');
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
it('should disable docs route when docsPath is false', async () => {
|
|
178
|
+
const endpoint = new Endpoint({
|
|
179
|
+
route: '/test',
|
|
180
|
+
method: 'GET',
|
|
181
|
+
fn: async () => ({ message: 'test' }),
|
|
182
|
+
services: [],
|
|
183
|
+
logger,
|
|
184
|
+
timeout: undefined,
|
|
185
|
+
memorySize: undefined,
|
|
186
|
+
authorize: undefined,
|
|
187
|
+
getSession: undefined,
|
|
188
|
+
status: undefined,
|
|
189
|
+
description: undefined,
|
|
190
|
+
input: undefined,
|
|
191
|
+
output: undefined,
|
|
192
|
+
});
|
|
193
|
+
|
|
194
|
+
const endpoints = [endpoint] as Endpoint<
|
|
195
|
+
any,
|
|
196
|
+
any,
|
|
197
|
+
any,
|
|
198
|
+
any,
|
|
199
|
+
any,
|
|
200
|
+
any,
|
|
201
|
+
any
|
|
202
|
+
>[];
|
|
203
|
+
|
|
204
|
+
const app = new Hono();
|
|
205
|
+
HonoEndpoint.addRoutes(
|
|
206
|
+
endpoints,
|
|
207
|
+
{ register: async () => ({}) } as any,
|
|
208
|
+
app,
|
|
209
|
+
{ docsPath: false },
|
|
210
|
+
);
|
|
211
|
+
|
|
212
|
+
const response = await app.request('/docs');
|
|
213
|
+
expect(response.status).toBe(404);
|
|
214
|
+
});
|
|
215
|
+
|
|
216
|
+
it('should include custom OpenAPI options', async () => {
|
|
217
|
+
const endpoint = new Endpoint({
|
|
218
|
+
route: '/test',
|
|
219
|
+
method: 'GET',
|
|
220
|
+
fn: async () => ({ message: 'test' }),
|
|
221
|
+
services: [],
|
|
222
|
+
logger,
|
|
223
|
+
timeout: undefined,
|
|
224
|
+
memorySize: undefined,
|
|
225
|
+
authorize: undefined,
|
|
226
|
+
getSession: undefined,
|
|
227
|
+
status: undefined,
|
|
228
|
+
description: undefined,
|
|
229
|
+
input: undefined,
|
|
230
|
+
output: undefined,
|
|
231
|
+
});
|
|
232
|
+
const endpoints = [endpoint] as Endpoint<
|
|
233
|
+
any,
|
|
234
|
+
any,
|
|
235
|
+
any,
|
|
236
|
+
any,
|
|
237
|
+
any,
|
|
238
|
+
any,
|
|
239
|
+
any
|
|
240
|
+
>[];
|
|
241
|
+
|
|
242
|
+
const app = new Hono();
|
|
243
|
+
HonoEndpoint.addRoutes(
|
|
244
|
+
endpoints,
|
|
245
|
+
{ register: async () => ({}) } as any,
|
|
246
|
+
app,
|
|
247
|
+
{
|
|
248
|
+
openApiOptions: {
|
|
249
|
+
title: 'My Custom API',
|
|
250
|
+
version: '2.0.0',
|
|
251
|
+
description: 'This is a custom API description',
|
|
252
|
+
},
|
|
253
|
+
},
|
|
254
|
+
);
|
|
255
|
+
|
|
256
|
+
const response = await app.request('/docs');
|
|
257
|
+
const openApiSchema = await response.json();
|
|
258
|
+
|
|
259
|
+
expect(openApiSchema.info).toEqual({
|
|
260
|
+
title: 'My Custom API',
|
|
261
|
+
version: '2.0.0',
|
|
262
|
+
description: 'This is a custom API description',
|
|
263
|
+
});
|
|
264
|
+
});
|
|
265
|
+
|
|
266
|
+
it('should include tags in OpenAPI documentation', async () => {
|
|
267
|
+
const userEndpoint = e
|
|
268
|
+
.get('/users/:id')
|
|
269
|
+
.description('Get user by ID')
|
|
270
|
+
.tags(['users', 'profile'])
|
|
271
|
+
.params(z.object({ id: z.string().describe('User ID') }))
|
|
272
|
+
.output(z.object({ id: z.string(), name: z.string() }))
|
|
273
|
+
.handle(({ params }) => ({ id: params.id, name: 'John Doe' }));
|
|
274
|
+
|
|
275
|
+
const adminEndpoint = e
|
|
276
|
+
.post('/admin/settings')
|
|
277
|
+
.description('Update admin settings')
|
|
278
|
+
.tags(['admin', 'settings'])
|
|
279
|
+
.body(z.object({ setting: z.string() }))
|
|
280
|
+
.output(z.object({ success: z.boolean() }))
|
|
281
|
+
.handle(() => ({ success: true }));
|
|
282
|
+
|
|
283
|
+
const endpoints = [userEndpoint, adminEndpoint] as Endpoint<
|
|
284
|
+
any,
|
|
285
|
+
any,
|
|
286
|
+
any,
|
|
287
|
+
any,
|
|
288
|
+
any,
|
|
289
|
+
any,
|
|
290
|
+
any
|
|
291
|
+
>[];
|
|
292
|
+
|
|
293
|
+
const app = new Hono();
|
|
294
|
+
HonoEndpoint.addRoutes(
|
|
295
|
+
endpoints,
|
|
296
|
+
{ register: async () => ({}) } as any,
|
|
297
|
+
app,
|
|
298
|
+
);
|
|
299
|
+
|
|
300
|
+
const response = await app.request('/docs');
|
|
301
|
+
expect(response.status).toBe(200);
|
|
302
|
+
|
|
303
|
+
const openApiSchema = await response.json();
|
|
304
|
+
|
|
305
|
+
// Check that the user endpoint has the correct tags
|
|
306
|
+
expect(openApiSchema.paths['/users/{id}'].get.tags).toEqual([
|
|
307
|
+
'users',
|
|
308
|
+
'profile',
|
|
309
|
+
]);
|
|
310
|
+
|
|
311
|
+
// Check that the admin endpoint has the correct tags
|
|
312
|
+
expect(openApiSchema.paths['/admin/settings'].post.tags).toEqual([
|
|
313
|
+
'admin',
|
|
314
|
+
'settings',
|
|
315
|
+
]);
|
|
316
|
+
});
|
|
317
|
+
});
|
|
@@ -0,0 +1,289 @@
|
|
|
1
|
+
import { EnvironmentParser } from '@geekmidas/envkit';
|
|
2
|
+
import type { EventPublisher, PublishableMessage } from '@geekmidas/events';
|
|
3
|
+
import {
|
|
4
|
+
PgBossConnection,
|
|
5
|
+
PgBossPublisher,
|
|
6
|
+
PgBossSubscriber,
|
|
7
|
+
} from '@geekmidas/events/pgboss';
|
|
8
|
+
import type { Service } from '@geekmidas/services';
|
|
9
|
+
import { ServiceDiscovery } from '@geekmidas/services';
|
|
10
|
+
import { Hono } from 'hono';
|
|
11
|
+
import { Client } from 'pg';
|
|
12
|
+
import { afterAll, beforeAll, describe, expect, it } from 'vitest';
|
|
13
|
+
import { z } from 'zod';
|
|
14
|
+
import { e } from '../EndpointFactory';
|
|
15
|
+
import { HonoEndpoint } from '../HonoEndpointAdaptor';
|
|
16
|
+
|
|
17
|
+
type OrderEvent =
|
|
18
|
+
| PublishableMessage<'order.created', { orderId: string; total: number }>
|
|
19
|
+
| PublishableMessage<'notification.sent', { orderId: string; type: string }>;
|
|
20
|
+
|
|
21
|
+
const POSTGRES_URL = 'postgres://geekmidas:geekmidas@localhost:5432/geekmidas';
|
|
22
|
+
const TEST_SCHEMA = 'pgboss_hono_publisher_test';
|
|
23
|
+
|
|
24
|
+
const uniqueQueue = () =>
|
|
25
|
+
`test-${Date.now()}-${Math.random().toString(36).substring(7)}`;
|
|
26
|
+
|
|
27
|
+
// Drop the test schema before pg-boss runs. Without this, a stale schema left
|
|
28
|
+
// behind by an older pg-boss version trips v12's migrator because it sees the
|
|
29
|
+
// `version` table but not the new `job_common` table.
|
|
30
|
+
async function dropTestSchema() {
|
|
31
|
+
const client = new Client({ connectionString: POSTGRES_URL });
|
|
32
|
+
await client.connect();
|
|
33
|
+
try {
|
|
34
|
+
await client.query(`DROP SCHEMA IF EXISTS "${TEST_SCHEMA}" CASCADE`);
|
|
35
|
+
} finally {
|
|
36
|
+
await client.end();
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
describe('HonoEndpoint with PgBoss Publisher', () => {
|
|
41
|
+
let connection: PgBossConnection;
|
|
42
|
+
let envParser: EnvironmentParser<{}>;
|
|
43
|
+
|
|
44
|
+
beforeAll(async () => {
|
|
45
|
+
await dropTestSchema();
|
|
46
|
+
connection = new PgBossConnection({
|
|
47
|
+
connectionString: POSTGRES_URL,
|
|
48
|
+
schema: TEST_SCHEMA,
|
|
49
|
+
});
|
|
50
|
+
await connection.connect();
|
|
51
|
+
envParser = new EnvironmentParser({});
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
afterAll(async () => {
|
|
55
|
+
await connection.close();
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it('should publish events to pg-boss after successful endpoint execution', async () => {
|
|
59
|
+
const eventType = uniqueQueue();
|
|
60
|
+
const received: any[] = [];
|
|
61
|
+
|
|
62
|
+
const publisher = new PgBossPublisher<OrderEvent>(connection);
|
|
63
|
+
|
|
64
|
+
const PgBossPublisherService: Service<
|
|
65
|
+
'eventPublisher',
|
|
66
|
+
EventPublisher<OrderEvent>
|
|
67
|
+
> = {
|
|
68
|
+
serviceName: 'eventPublisher' as const,
|
|
69
|
+
register: () => publisher,
|
|
70
|
+
};
|
|
71
|
+
|
|
72
|
+
const outputSchema = z.object({
|
|
73
|
+
orderId: z.string(),
|
|
74
|
+
total: z.number(),
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
const endpoint = e
|
|
78
|
+
.publisher(PgBossPublisherService)
|
|
79
|
+
.post('/orders')
|
|
80
|
+
.output(outputSchema)
|
|
81
|
+
.event({
|
|
82
|
+
type: eventType as any,
|
|
83
|
+
payload: (response) => ({
|
|
84
|
+
orderId: response.orderId,
|
|
85
|
+
total: response.total,
|
|
86
|
+
}),
|
|
87
|
+
})
|
|
88
|
+
.handle(async () => ({
|
|
89
|
+
orderId: 'order-42',
|
|
90
|
+
total: 99.99,
|
|
91
|
+
}));
|
|
92
|
+
|
|
93
|
+
const serviceDiscovery = ServiceDiscovery.getInstance(envParser);
|
|
94
|
+
const app = new Hono();
|
|
95
|
+
HonoEndpoint.applyEventMiddleware(app, serviceDiscovery);
|
|
96
|
+
|
|
97
|
+
const adaptor = new HonoEndpoint(endpoint);
|
|
98
|
+
adaptor.addRoute(serviceDiscovery, app);
|
|
99
|
+
|
|
100
|
+
// Subscribe to events via pg-boss before making the request
|
|
101
|
+
const subscriber = new PgBossSubscriber<OrderEvent>(connection, {
|
|
102
|
+
pollingIntervalSeconds: 1,
|
|
103
|
+
});
|
|
104
|
+
await subscriber.subscribe([eventType as any], async (event) => {
|
|
105
|
+
received.push(event);
|
|
106
|
+
});
|
|
107
|
+
|
|
108
|
+
// Fire the endpoint
|
|
109
|
+
const response = await app.request('/orders', {
|
|
110
|
+
method: 'POST',
|
|
111
|
+
body: JSON.stringify({}),
|
|
112
|
+
headers: { 'Content-Type': 'application/json' },
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
expect(response.status).toBe(200);
|
|
116
|
+
expect(await response.json()).toEqual({
|
|
117
|
+
orderId: 'order-42',
|
|
118
|
+
total: 99.99,
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
// Wait for pg-boss to poll and deliver the event
|
|
122
|
+
await new Promise((resolve) => setTimeout(resolve, 3000));
|
|
123
|
+
|
|
124
|
+
expect(received.length).toBe(1);
|
|
125
|
+
expect(received[0]).toEqual({
|
|
126
|
+
type: eventType,
|
|
127
|
+
payload: { orderId: 'order-42', total: 99.99 },
|
|
128
|
+
});
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
it('should publish multiple events and respect when conditions', async () => {
|
|
132
|
+
const createdType = uniqueQueue();
|
|
133
|
+
const notificationType = uniqueQueue();
|
|
134
|
+
const received: any[] = [];
|
|
135
|
+
|
|
136
|
+
const publisher = new PgBossPublisher<OrderEvent>(connection);
|
|
137
|
+
|
|
138
|
+
const PgBossPublisherService: Service<
|
|
139
|
+
'eventPublisher',
|
|
140
|
+
EventPublisher<OrderEvent>
|
|
141
|
+
> = {
|
|
142
|
+
serviceName: 'eventPublisher' as const,
|
|
143
|
+
register: () => publisher,
|
|
144
|
+
};
|
|
145
|
+
|
|
146
|
+
const outputSchema = z.object({
|
|
147
|
+
orderId: z.string(),
|
|
148
|
+
total: z.number(),
|
|
149
|
+
isHighValue: z.boolean(),
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
const endpoint = e
|
|
153
|
+
.publisher(PgBossPublisherService)
|
|
154
|
+
.post('/orders')
|
|
155
|
+
.output(outputSchema)
|
|
156
|
+
.event({
|
|
157
|
+
type: createdType as any,
|
|
158
|
+
payload: (response) => ({
|
|
159
|
+
orderId: response.orderId,
|
|
160
|
+
total: response.total,
|
|
161
|
+
}),
|
|
162
|
+
})
|
|
163
|
+
.event({
|
|
164
|
+
type: notificationType as any,
|
|
165
|
+
payload: (response) => ({
|
|
166
|
+
orderId: response.orderId,
|
|
167
|
+
type: 'high-value-alert',
|
|
168
|
+
}),
|
|
169
|
+
when: (response) => response.isHighValue === true,
|
|
170
|
+
})
|
|
171
|
+
.handle(async () => ({
|
|
172
|
+
orderId: 'order-99',
|
|
173
|
+
total: 5000,
|
|
174
|
+
isHighValue: true,
|
|
175
|
+
}));
|
|
176
|
+
|
|
177
|
+
const serviceDiscovery = ServiceDiscovery.getInstance(envParser);
|
|
178
|
+
const app = new Hono();
|
|
179
|
+
HonoEndpoint.applyEventMiddleware(app, serviceDiscovery);
|
|
180
|
+
|
|
181
|
+
const adaptor = new HonoEndpoint(endpoint);
|
|
182
|
+
adaptor.addRoute(serviceDiscovery, app);
|
|
183
|
+
|
|
184
|
+
// Subscribe to both event types
|
|
185
|
+
const subscriber = new PgBossSubscriber<OrderEvent>(connection, {
|
|
186
|
+
pollingIntervalSeconds: 1,
|
|
187
|
+
});
|
|
188
|
+
await subscriber.subscribe(
|
|
189
|
+
[createdType as any, notificationType as any],
|
|
190
|
+
async (event) => {
|
|
191
|
+
received.push(event);
|
|
192
|
+
},
|
|
193
|
+
);
|
|
194
|
+
|
|
195
|
+
// Fire the endpoint
|
|
196
|
+
const response = await app.request('/orders', {
|
|
197
|
+
method: 'POST',
|
|
198
|
+
body: JSON.stringify({}),
|
|
199
|
+
headers: { 'Content-Type': 'application/json' },
|
|
200
|
+
});
|
|
201
|
+
|
|
202
|
+
expect(response.status).toBe(200);
|
|
203
|
+
|
|
204
|
+
// Wait for pg-boss to poll and deliver events
|
|
205
|
+
await new Promise((resolve) => setTimeout(resolve, 3000));
|
|
206
|
+
|
|
207
|
+
expect(received.length).toBe(2);
|
|
208
|
+
expect(received).toEqual(
|
|
209
|
+
expect.arrayContaining([
|
|
210
|
+
{
|
|
211
|
+
type: createdType,
|
|
212
|
+
payload: { orderId: 'order-99', total: 5000 },
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
type: notificationType,
|
|
216
|
+
payload: { orderId: 'order-99', type: 'high-value-alert' },
|
|
217
|
+
},
|
|
218
|
+
]),
|
|
219
|
+
);
|
|
220
|
+
});
|
|
221
|
+
|
|
222
|
+
it('should not publish events when when condition is false', async () => {
|
|
223
|
+
const eventType = uniqueQueue();
|
|
224
|
+
const received: any[] = [];
|
|
225
|
+
|
|
226
|
+
const publisher = new PgBossPublisher<OrderEvent>(connection);
|
|
227
|
+
|
|
228
|
+
const PgBossPublisherService: Service<
|
|
229
|
+
'eventPublisher',
|
|
230
|
+
EventPublisher<OrderEvent>
|
|
231
|
+
> = {
|
|
232
|
+
serviceName: 'eventPublisher' as const,
|
|
233
|
+
register: () => publisher,
|
|
234
|
+
};
|
|
235
|
+
|
|
236
|
+
const outputSchema = z.object({
|
|
237
|
+
orderId: z.string(),
|
|
238
|
+
total: z.number(),
|
|
239
|
+
isHighValue: z.boolean(),
|
|
240
|
+
});
|
|
241
|
+
|
|
242
|
+
const endpoint = e
|
|
243
|
+
.publisher(PgBossPublisherService)
|
|
244
|
+
.post('/orders')
|
|
245
|
+
.output(outputSchema)
|
|
246
|
+
.event({
|
|
247
|
+
type: eventType as any,
|
|
248
|
+
payload: (response) => ({
|
|
249
|
+
orderId: response.orderId,
|
|
250
|
+
type: 'high-value-alert',
|
|
251
|
+
}),
|
|
252
|
+
when: (response) => response.isHighValue === true,
|
|
253
|
+
})
|
|
254
|
+
.handle(async () => ({
|
|
255
|
+
orderId: 'order-small',
|
|
256
|
+
total: 5,
|
|
257
|
+
isHighValue: false,
|
|
258
|
+
}));
|
|
259
|
+
|
|
260
|
+
const serviceDiscovery = ServiceDiscovery.getInstance(envParser);
|
|
261
|
+
const app = new Hono();
|
|
262
|
+
HonoEndpoint.applyEventMiddleware(app, serviceDiscovery);
|
|
263
|
+
|
|
264
|
+
const adaptor = new HonoEndpoint(endpoint);
|
|
265
|
+
adaptor.addRoute(serviceDiscovery, app);
|
|
266
|
+
|
|
267
|
+
// Subscribe
|
|
268
|
+
const subscriber = new PgBossSubscriber<OrderEvent>(connection, {
|
|
269
|
+
pollingIntervalSeconds: 1,
|
|
270
|
+
});
|
|
271
|
+
await subscriber.subscribe([eventType as any], async (event) => {
|
|
272
|
+
received.push(event);
|
|
273
|
+
});
|
|
274
|
+
|
|
275
|
+
// Fire the endpoint
|
|
276
|
+
const response = await app.request('/orders', {
|
|
277
|
+
method: 'POST',
|
|
278
|
+
body: JSON.stringify({}),
|
|
279
|
+
headers: { 'Content-Type': 'application/json' },
|
|
280
|
+
});
|
|
281
|
+
|
|
282
|
+
expect(response.status).toBe(200);
|
|
283
|
+
|
|
284
|
+
// Wait to confirm no events arrive
|
|
285
|
+
await new Promise((resolve) => setTimeout(resolve, 3000));
|
|
286
|
+
|
|
287
|
+
expect(received.length).toBe(0);
|
|
288
|
+
});
|
|
289
|
+
});
|