@geekmidas/cli 0.3.0 → 0.5.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/README.md +488 -71
- package/dist/CronGenerator-BPTqNYOR.d.cts +14 -0
- package/dist/{CronGenerator-Bh26MaNA.mjs → CronGenerator-CCRYptuT.mjs} +2 -2
- package/dist/{CronGenerator-Bh26MaNA.mjs.map → CronGenerator-CCRYptuT.mjs.map} +1 -1
- package/dist/{CronGenerator-C6MF8rlG.cjs → CronGenerator-D4TWXQbh.cjs} +2 -2
- package/dist/{CronGenerator-C6MF8rlG.cjs.map → CronGenerator-D4TWXQbh.cjs.map} +1 -1
- package/dist/CronGenerator-YAj59JUd.d.mts +14 -0
- package/dist/EndpointGenerator-ChAD1INz.d.cts +19 -0
- package/dist/EndpointGenerator-Cj3O1U8-.d.mts +19 -0
- package/dist/{EndpointGenerator-CWh18d92.mjs → EndpointGenerator-DGivkPLT.mjs} +77 -7
- package/dist/EndpointGenerator-DGivkPLT.mjs.map +1 -0
- package/dist/{EndpointGenerator-C73wNoih.cjs → EndpointGenerator-npWEDoK2.cjs} +77 -7
- package/dist/EndpointGenerator-npWEDoK2.cjs.map +1 -0
- package/dist/FunctionGenerator-429-9NER.d.cts +14 -0
- package/dist/FunctionGenerator-BQ4ehoID.d.mts +14 -0
- package/dist/{FunctionGenerator-BNE_GC7N.mjs → FunctionGenerator-CVk0h8tO.mjs} +2 -2
- package/dist/{FunctionGenerator-BNE_GC7N.mjs.map → FunctionGenerator-CVk0h8tO.mjs.map} +1 -1
- package/dist/{FunctionGenerator-FgZUTd8L.cjs → FunctionGenerator-DYTnyr4c.cjs} +2 -2
- package/dist/{FunctionGenerator-FgZUTd8L.cjs.map → FunctionGenerator-DYTnyr4c.cjs.map} +1 -1
- package/dist/Generator-BjHK_qce.d.mts +27 -0
- package/dist/{Generator-UanJW0_V.mjs → Generator-CDt4pB3W.mjs} +1 -1
- package/dist/{Generator-UanJW0_V.mjs.map → Generator-CDt4pB3W.mjs.map} +1 -1
- package/dist/{Generator-CDoEXCDg.cjs → Generator-CLVplqm2.cjs} +1 -1
- package/dist/{Generator-CDoEXCDg.cjs.map → Generator-CLVplqm2.cjs.map} +1 -1
- package/dist/Generator-DxQMCQp7.d.cts +27 -0
- package/dist/OpenApiTsGenerator-Be-sKGTT.cjs +501 -0
- package/dist/OpenApiTsGenerator-Be-sKGTT.cjs.map +1 -0
- package/dist/OpenApiTsGenerator-C4mHHaku.mjs +495 -0
- package/dist/OpenApiTsGenerator-C4mHHaku.mjs.map +1 -0
- package/dist/SubscriberGenerator-7uX42xyG.d.mts +15 -0
- package/dist/{SubscriberGenerator-Dnlj_1FK.mjs → SubscriberGenerator-DABaJXML.mjs} +2 -2
- package/dist/{SubscriberGenerator-Dnlj_1FK.mjs.map → SubscriberGenerator-DABaJXML.mjs.map} +1 -1
- package/dist/{SubscriberGenerator-Bd-a7aiw.cjs → SubscriberGenerator-D_zpNGFr.cjs} +2 -2
- package/dist/{SubscriberGenerator-Bd-a7aiw.cjs.map → SubscriberGenerator-D_zpNGFr.cjs.map} +1 -1
- package/dist/SubscriberGenerator-Dtb3HS4i.d.cts +15 -0
- package/dist/api-B3SCEHPf.cjs +190 -0
- package/dist/api-B3SCEHPf.cjs.map +1 -0
- package/dist/api-BKIN0s0S.mjs +184 -0
- package/dist/api-BKIN0s0S.mjs.map +1 -0
- package/dist/build/index.cjs +11 -10
- package/dist/build/index.d.cts +7 -0
- package/dist/build/index.d.mts +7 -0
- package/dist/build/index.mjs +11 -10
- package/dist/build/manifests.cjs +1 -1
- package/dist/build/manifests.d.cts +13 -0
- package/dist/build/manifests.d.mts +13 -0
- package/dist/build/manifests.mjs +1 -1
- package/dist/build/providerResolver.cjs +1 -1
- package/dist/build/providerResolver.d.cts +23 -0
- package/dist/build/providerResolver.d.mts +23 -0
- package/dist/build/providerResolver.mjs +1 -1
- package/dist/build/types.d.cts +3 -0
- package/dist/build/types.d.mts +3 -0
- package/dist/{build-C6uEGRj8.mjs → build-B8C_qHir.mjs} +15 -13
- package/dist/build-B8C_qHir.mjs.map +1 -0
- package/dist/{build-CBYBPZpC.cjs → build-D0Wr49bf.cjs} +15 -13
- package/dist/build-D0Wr49bf.cjs.map +1 -0
- package/dist/config-Ba-Gbpbc.d.cts +11 -0
- package/dist/config-Bq72aj8e.mjs +75 -0
- package/dist/config-Bq72aj8e.mjs.map +1 -0
- package/dist/config-CFls09Ey.cjs +93 -0
- package/dist/config-CFls09Ey.cjs.map +1 -0
- package/dist/config-CLEDqKO3.cjs +157 -0
- package/dist/config-CLEDqKO3.cjs.map +1 -0
- package/dist/config-DBsmMDhf.d.mts +11 -0
- package/dist/config-Dp8RonV_.mjs +151 -0
- package/dist/config-Dp8RonV_.mjs.map +1 -0
- package/dist/config.cjs +4 -2
- package/dist/config.d.cts +48 -0
- package/dist/config.d.mts +48 -0
- package/dist/config.mjs +2 -2
- package/dist/dev/index.cjs +12 -10
- package/dist/dev/index.d.cts +36 -0
- package/dist/dev/index.d.mts +36 -0
- package/dist/dev/index.mjs +10 -10
- package/dist/dev-B734w3L1.mjs +343 -0
- package/dist/dev-B734w3L1.mjs.map +1 -0
- package/dist/{dev-DbtyToc7.cjs → dev-DHqYn8k4.cjs} +161 -47
- package/dist/dev-DHqYn8k4.cjs.map +1 -0
- package/dist/docker-5d8Yh5_X.cjs +119 -0
- package/dist/docker-5d8Yh5_X.cjs.map +1 -0
- package/dist/docker-DlUqdFle.mjs +113 -0
- package/dist/docker-DlUqdFle.mjs.map +1 -0
- package/dist/env-B-OKjgI4.cjs +144 -0
- package/dist/env-B-OKjgI4.cjs.map +1 -0
- package/dist/env-HfuJRlg5.d.cts +11 -0
- package/dist/env-nd-iQPYM.d.mts +11 -0
- package/dist/env-tv1HlZlw.mjs +138 -0
- package/dist/env-tv1HlZlw.mjs.map +1 -0
- package/dist/generators/CronGenerator.cjs +2 -2
- package/dist/generators/CronGenerator.d.cts +5 -0
- package/dist/generators/CronGenerator.d.mts +5 -0
- package/dist/generators/CronGenerator.mjs +2 -2
- package/dist/generators/EndpointGenerator.cjs +2 -2
- package/dist/generators/EndpointGenerator.d.cts +5 -0
- package/dist/generators/EndpointGenerator.d.mts +5 -0
- package/dist/generators/EndpointGenerator.mjs +2 -2
- package/dist/generators/FunctionGenerator.cjs +2 -2
- package/dist/generators/FunctionGenerator.d.cts +5 -0
- package/dist/generators/FunctionGenerator.d.mts +5 -0
- package/dist/generators/FunctionGenerator.mjs +2 -2
- package/dist/generators/Generator.cjs +1 -1
- package/dist/generators/Generator.d.cts +4 -0
- package/dist/generators/Generator.d.mts +4 -0
- package/dist/generators/Generator.mjs +1 -1
- package/dist/generators/OpenApiTsGenerator.cjs +3 -0
- package/dist/generators/OpenApiTsGenerator.d.cts +44 -0
- package/dist/generators/OpenApiTsGenerator.d.mts +44 -0
- package/dist/generators/OpenApiTsGenerator.mjs +3 -0
- package/dist/generators/SubscriberGenerator.cjs +2 -2
- package/dist/generators/SubscriberGenerator.d.cts +5 -0
- package/dist/generators/SubscriberGenerator.d.mts +5 -0
- package/dist/generators/SubscriberGenerator.mjs +2 -2
- package/dist/generators/index.cjs +6 -6
- package/dist/generators/index.d.cts +8 -0
- package/dist/generators/index.d.mts +8 -0
- package/dist/generators/index.mjs +6 -6
- package/dist/index-C523No_B.d.mts +64 -0
- package/dist/index-DrzN4xkQ.d.cts +64 -0
- package/dist/index.cjs +56 -18
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -0
- package/dist/index.d.mts +1 -0
- package/dist/index.mjs +56 -18
- package/dist/index.mjs.map +1 -1
- package/dist/init/generators/config.cjs +3 -0
- package/dist/init/generators/config.d.cts +3 -0
- package/dist/init/generators/config.d.mts +3 -0
- package/dist/init/generators/config.mjs +3 -0
- package/dist/init/generators/docker.cjs +3 -0
- package/dist/init/generators/docker.d.cts +11 -0
- package/dist/init/generators/docker.d.mts +11 -0
- package/dist/init/generators/docker.mjs +3 -0
- package/dist/init/generators/env.cjs +3 -0
- package/dist/init/generators/env.d.cts +3 -0
- package/dist/init/generators/env.d.mts +3 -0
- package/dist/init/generators/env.mjs +3 -0
- package/dist/init/generators/index.cjs +9 -0
- package/dist/init/generators/index.d.cts +6 -0
- package/dist/init/generators/index.d.mts +6 -0
- package/dist/init/generators/index.mjs +6 -0
- package/dist/init/generators/models.cjs +3 -0
- package/dist/init/generators/models.d.cts +11 -0
- package/dist/init/generators/models.d.mts +11 -0
- package/dist/init/generators/models.mjs +3 -0
- package/dist/init/generators/monorepo.cjs +3 -0
- package/dist/init/generators/monorepo.d.cts +11 -0
- package/dist/init/generators/monorepo.d.mts +11 -0
- package/dist/init/generators/monorepo.mjs +3 -0
- package/dist/init/generators/package.cjs +3 -0
- package/dist/init/generators/package.d.cts +3 -0
- package/dist/init/generators/package.d.mts +3 -0
- package/dist/init/generators/package.mjs +3 -0
- package/dist/init/generators/source.cjs +3 -0
- package/dist/init/generators/source.d.cts +3 -0
- package/dist/init/generators/source.d.mts +3 -0
- package/dist/init/generators/source.mjs +3 -0
- package/dist/init/index.cjs +16 -0
- package/dist/init/index.d.cts +17 -0
- package/dist/init/index.d.mts +17 -0
- package/dist/init/index.mjs +16 -0
- package/dist/init/templates/api.cjs +3 -0
- package/dist/init/templates/api.d.cts +7 -0
- package/dist/init/templates/api.d.mts +7 -0
- package/dist/init/templates/api.mjs +3 -0
- package/dist/init/templates/index.cjs +10 -0
- package/dist/init/templates/index.d.cts +2 -0
- package/dist/init/templates/index.d.mts +2 -0
- package/dist/init/templates/index.mjs +7 -0
- package/dist/init/templates/minimal.cjs +3 -0
- package/dist/init/templates/minimal.d.cts +7 -0
- package/dist/init/templates/minimal.d.mts +7 -0
- package/dist/init/templates/minimal.mjs +3 -0
- package/dist/init/templates/serverless.cjs +3 -0
- package/dist/init/templates/serverless.d.cts +7 -0
- package/dist/init/templates/serverless.d.mts +7 -0
- package/dist/init/templates/serverless.mjs +3 -0
- package/dist/init/templates/worker.cjs +3 -0
- package/dist/init/templates/worker.d.cts +7 -0
- package/dist/init/templates/worker.d.mts +7 -0
- package/dist/init/templates/worker.mjs +3 -0
- package/dist/init/utils.cjs +7 -0
- package/dist/init/utils.d.cts +25 -0
- package/dist/init/utils.d.mts +25 -0
- package/dist/init/utils.mjs +3 -0
- package/dist/init-CtOnZn3G.mjs +145 -0
- package/dist/init-CtOnZn3G.mjs.map +1 -0
- package/dist/init-qLFsWR-R.cjs +151 -0
- package/dist/init-qLFsWR-R.cjs.map +1 -0
- package/dist/{manifests-C2eMoMUm.mjs → manifests-DIA_2QYd.mjs} +1 -1
- package/dist/{manifests-C2eMoMUm.mjs.map → manifests-DIA_2QYd.mjs.map} +1 -1
- package/dist/{manifests-CK1VV_pM.cjs → manifests-VJ9-2JpW.cjs} +1 -1
- package/dist/{manifests-CK1VV_pM.cjs.map → manifests-VJ9-2JpW.cjs.map} +1 -1
- package/dist/minimal-Bdhhpp7v.cjs +93 -0
- package/dist/minimal-Bdhhpp7v.cjs.map +1 -0
- package/dist/minimal-C4GsE45s.mjs +87 -0
- package/dist/minimal-C4GsE45s.mjs.map +1 -0
- package/dist/models-DyNwdOcz.cjs +121 -0
- package/dist/models-DyNwdOcz.cjs.map +1 -0
- package/dist/models-cvNg6Oea.mjs +115 -0
- package/dist/models-cvNg6Oea.mjs.map +1 -0
- package/dist/monorepo-Cknwzj5C.mjs +184 -0
- package/dist/monorepo-Cknwzj5C.mjs.map +1 -0
- package/dist/monorepo-sEK8gW59.cjs +190 -0
- package/dist/monorepo-sEK8gW59.cjs.map +1 -0
- package/dist/openapi-BQWPWyNB.cjs +56 -0
- package/dist/openapi-BQWPWyNB.cjs.map +1 -0
- package/dist/openapi-DBX8cJJ8.mjs +50 -0
- package/dist/openapi-DBX8cJJ8.mjs.map +1 -0
- package/dist/{openapi-react-query-D9Z7lh0p.cjs → openapi-react-query-DxHjXQvg.cjs} +1 -1
- package/dist/{openapi-react-query-D9Z7lh0p.cjs.map → openapi-react-query-DxHjXQvg.cjs.map} +1 -1
- package/dist/{openapi-react-query-MEBlYIM1.mjs → openapi-react-query-o7Mp1Jd5.mjs} +1 -1
- package/dist/{openapi-react-query-MEBlYIM1.mjs.map → openapi-react-query-o7Mp1Jd5.mjs.map} +1 -1
- package/dist/openapi-react-query.cjs +1 -1
- package/dist/openapi-react-query.d.cts +11 -0
- package/dist/openapi-react-query.d.mts +11 -0
- package/dist/openapi-react-query.mjs +1 -1
- package/dist/openapi.cjs +5 -4
- package/dist/openapi.d.cts +11 -0
- package/dist/openapi.d.mts +11 -0
- package/dist/openapi.mjs +5 -4
- package/dist/package-C7WhWU8m.d.mts +11 -0
- package/dist/package-CIfmeuSW.mjs +51 -0
- package/dist/package-CIfmeuSW.mjs.map +1 -0
- package/dist/package-DvWEMz6z.d.cts +11 -0
- package/dist/package-PP-o1nvq.cjs +57 -0
- package/dist/package-PP-o1nvq.cjs.map +1 -0
- package/dist/{providerResolver-B_TjNF0_.mjs → providerResolver-DEVKngbC.mjs} +1 -1
- package/dist/{providerResolver-B_TjNF0_.mjs.map → providerResolver-DEVKngbC.mjs.map} +1 -1
- package/dist/{providerResolver-DgvzNfP4.cjs → providerResolver-DOTbN9jo.cjs} +1 -1
- package/dist/{providerResolver-DgvzNfP4.cjs.map → providerResolver-DOTbN9jo.cjs.map} +1 -1
- package/dist/serverless-DkHBF2vC.mjs +108 -0
- package/dist/serverless-DkHBF2vC.mjs.map +1 -0
- package/dist/serverless-Yav3GRVz.cjs +114 -0
- package/dist/serverless-Yav3GRVz.cjs.map +1 -0
- package/dist/source-D6v2BnKT.d.mts +11 -0
- package/dist/source-D8fK9qRo.d.cts +11 -0
- package/dist/source-DT5Xhiob.cjs +17 -0
- package/dist/source-DT5Xhiob.cjs.map +1 -0
- package/dist/source-DnaH_MLA.mjs +11 -0
- package/dist/source-DnaH_MLA.mjs.map +1 -0
- package/dist/templates-CBFUwpBy.mjs +64 -0
- package/dist/templates-CBFUwpBy.mjs.map +1 -0
- package/dist/templates-DM_rtYYW.cjs +87 -0
- package/dist/templates-DM_rtYYW.cjs.map +1 -0
- package/dist/types-C4KITv-y.d.mts +51 -0
- package/dist/types-Cxl8-uwV.d.mts +129 -0
- package/dist/types-DB99_qIy.d.cts +129 -0
- package/dist/types-DLFN49M3.d.cts +51 -0
- package/dist/types.d.cts +2 -0
- package/dist/types.d.mts +2 -0
- package/dist/utils-BX3F4fT8.cjs +99 -0
- package/dist/utils-BX3F4fT8.cjs.map +1 -0
- package/dist/utils-C31-SWHP.mjs +69 -0
- package/dist/utils-C31-SWHP.mjs.map +1 -0
- package/dist/worker--8O5a3Hv.cjs +150 -0
- package/dist/worker--8O5a3Hv.cjs.map +1 -0
- package/dist/worker-Jme7uOOJ.mjs +144 -0
- package/dist/worker-Jme7uOOJ.mjs.map +1 -0
- package/docs/OPENAPI_TYPESCRIPT_DESIGN.md +408 -0
- package/package.json +19 -4
- package/src/__tests__/loadEnvFiles.spec.ts +131 -0
- package/src/__tests__/openapi.spec.ts +78 -63
- package/src/build/index.ts +14 -16
- package/src/build/types.ts +18 -2
- package/src/config.ts +61 -2
- package/src/dev/__tests__/index.spec.ts +98 -1
- package/src/dev/index.ts +229 -42
- package/src/generators/EndpointGenerator.ts +98 -5
- package/src/generators/OpenApiTsGenerator.ts +798 -0
- package/src/index.ts +32 -3
- package/src/init/__tests__/generators.spec.ts +366 -0
- package/src/init/__tests__/init.spec.ts +341 -0
- package/src/init/__tests__/utils.spec.ts +104 -0
- package/src/init/generators/config.ts +192 -0
- package/src/init/generators/docker.ts +134 -0
- package/src/init/generators/env.ts +182 -0
- package/src/init/generators/index.ts +4 -0
- package/src/init/generators/models.ts +129 -0
- package/src/init/generators/monorepo.ts +211 -0
- package/src/init/generators/package.ts +81 -0
- package/src/init/generators/source.ts +15 -0
- package/src/init/index.ts +206 -0
- package/src/init/templates/api.ts +218 -0
- package/src/init/templates/index.ts +108 -0
- package/src/init/templates/minimal.ts +102 -0
- package/src/init/templates/serverless.ts +129 -0
- package/src/init/templates/worker.ts +169 -0
- package/src/init/utils.ts +98 -0
- package/src/openapi.ts +36 -15
- package/src/types.ts +43 -0
- package/tsdown.config.ts +1 -1
- package/dist/EndpointGenerator-C73wNoih.cjs.map +0 -1
- package/dist/EndpointGenerator-CWh18d92.mjs.map +0 -1
- package/dist/build-C6uEGRj8.mjs.map +0 -1
- package/dist/build-CBYBPZpC.cjs.map +0 -1
- package/dist/config-D1EpSGk6.cjs +0 -36
- package/dist/config-D1EpSGk6.cjs.map +0 -1
- package/dist/config-U-mdW-7Y.mjs +0 -30
- package/dist/config-U-mdW-7Y.mjs.map +0 -1
- package/dist/dev-DbtyToc7.cjs.map +0 -1
- package/dist/dev-DnGYXuMn.mjs +0 -241
- package/dist/dev-DnGYXuMn.mjs.map +0 -1
- package/dist/openapi-BTHbPrxS.mjs +0 -36
- package/dist/openapi-BTHbPrxS.mjs.map +0 -1
- package/dist/openapi-CewcfoRH.cjs +0 -42
- package/dist/openapi-CewcfoRH.cjs.map +0 -1
- /package/dist/{generators-CEKtVh81.cjs → generators-3IemvCLk.cjs} +0 -0
- /package/dist/{generators-CsLujGXs.mjs → generators-FNpdfN6J.mjs} +0 -0
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
GeneratedFile,
|
|
3
|
+
TemplateConfig,
|
|
4
|
+
TemplateOptions,
|
|
5
|
+
} from './index.js';
|
|
6
|
+
|
|
7
|
+
export const minimalTemplate: TemplateConfig = {
|
|
8
|
+
name: 'minimal',
|
|
9
|
+
description: 'Basic health endpoint',
|
|
10
|
+
|
|
11
|
+
dependencies: {
|
|
12
|
+
'@geekmidas/constructs': 'workspace:*',
|
|
13
|
+
'@geekmidas/envkit': 'workspace:*',
|
|
14
|
+
'@geekmidas/logger': 'workspace:*',
|
|
15
|
+
hono: '~4.8.2',
|
|
16
|
+
pino: '~9.6.0',
|
|
17
|
+
},
|
|
18
|
+
|
|
19
|
+
devDependencies: {
|
|
20
|
+
'@biomejs/biome': '~1.9.4',
|
|
21
|
+
'@geekmidas/cli': 'workspace:*',
|
|
22
|
+
'@types/node': '~22.0.0',
|
|
23
|
+
tsx: '~4.20.0',
|
|
24
|
+
turbo: '~2.3.0',
|
|
25
|
+
typescript: '~5.8.2',
|
|
26
|
+
vitest: '~4.0.0',
|
|
27
|
+
},
|
|
28
|
+
|
|
29
|
+
scripts: {
|
|
30
|
+
dev: 'gkm dev',
|
|
31
|
+
build: 'gkm build',
|
|
32
|
+
test: 'vitest',
|
|
33
|
+
'test:once': 'vitest run',
|
|
34
|
+
typecheck: 'tsc --noEmit',
|
|
35
|
+
lint: 'biome lint .',
|
|
36
|
+
fmt: 'biome format . --write',
|
|
37
|
+
'fmt:check': 'biome format .',
|
|
38
|
+
},
|
|
39
|
+
|
|
40
|
+
files: (options: TemplateOptions): GeneratedFile[] => {
|
|
41
|
+
const files: GeneratedFile[] = [
|
|
42
|
+
// src/config/env.ts
|
|
43
|
+
{
|
|
44
|
+
path: 'src/config/env.ts',
|
|
45
|
+
content: `import { EnvironmentParser } from '@geekmidas/envkit';
|
|
46
|
+
|
|
47
|
+
export const envParser = new EnvironmentParser(process.env);
|
|
48
|
+
|
|
49
|
+
export const config = envParser
|
|
50
|
+
.create((get) => ({
|
|
51
|
+
port: get('PORT').string().transform(Number).default(3000),
|
|
52
|
+
nodeEnv: get('NODE_ENV').string().default('development'),
|
|
53
|
+
}))
|
|
54
|
+
.parse();
|
|
55
|
+
`,
|
|
56
|
+
},
|
|
57
|
+
|
|
58
|
+
// src/config/logger.ts - using pino
|
|
59
|
+
{
|
|
60
|
+
path: 'src/config/logger.ts',
|
|
61
|
+
content: `import { PinoLogger } from '@geekmidas/logger/pino';
|
|
62
|
+
|
|
63
|
+
export const logger = new PinoLogger({
|
|
64
|
+
app: '${options.name}',
|
|
65
|
+
level: process.env.LOG_LEVEL || 'info',
|
|
66
|
+
});
|
|
67
|
+
`,
|
|
68
|
+
},
|
|
69
|
+
|
|
70
|
+
// src/endpoints/health.ts
|
|
71
|
+
{
|
|
72
|
+
path: 'src/endpoints/health.ts',
|
|
73
|
+
content: `import { e } from '@geekmidas/constructs/endpoints';
|
|
74
|
+
|
|
75
|
+
export default e
|
|
76
|
+
.get('/health')
|
|
77
|
+
.handle(async () => ({
|
|
78
|
+
status: 'ok',
|
|
79
|
+
timestamp: new Date().toISOString(),
|
|
80
|
+
}));
|
|
81
|
+
`,
|
|
82
|
+
},
|
|
83
|
+
];
|
|
84
|
+
|
|
85
|
+
// Add Telescope config if enabled
|
|
86
|
+
if (options.telescope) {
|
|
87
|
+
files.push({
|
|
88
|
+
path: 'src/config/telescope.ts',
|
|
89
|
+
content: `import { Telescope } from '@geekmidas/telescope';
|
|
90
|
+
import { InMemoryStorage } from '@geekmidas/telescope/storage/memory';
|
|
91
|
+
|
|
92
|
+
export const telescope = new Telescope({
|
|
93
|
+
storage: new InMemoryStorage({ maxEntries: 100 }),
|
|
94
|
+
enabled: process.env.NODE_ENV === 'development',
|
|
95
|
+
});
|
|
96
|
+
`,
|
|
97
|
+
});
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return files;
|
|
101
|
+
},
|
|
102
|
+
};
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
GeneratedFile,
|
|
3
|
+
TemplateConfig,
|
|
4
|
+
TemplateOptions,
|
|
5
|
+
} from './index.js';
|
|
6
|
+
|
|
7
|
+
export const serverlessTemplate: TemplateConfig = {
|
|
8
|
+
name: 'serverless',
|
|
9
|
+
description: 'AWS Lambda handlers',
|
|
10
|
+
|
|
11
|
+
dependencies: {
|
|
12
|
+
'@geekmidas/constructs': 'workspace:*',
|
|
13
|
+
'@geekmidas/envkit': 'workspace:*',
|
|
14
|
+
'@geekmidas/logger': 'workspace:*',
|
|
15
|
+
'@geekmidas/cloud': 'workspace:*',
|
|
16
|
+
hono: '~4.8.2',
|
|
17
|
+
pino: '~9.6.0',
|
|
18
|
+
},
|
|
19
|
+
|
|
20
|
+
devDependencies: {
|
|
21
|
+
'@biomejs/biome': '~1.9.4',
|
|
22
|
+
'@geekmidas/cli': 'workspace:*',
|
|
23
|
+
'@types/aws-lambda': '~8.10.92',
|
|
24
|
+
'@types/node': '~22.0.0',
|
|
25
|
+
tsx: '~4.20.0',
|
|
26
|
+
turbo: '~2.3.0',
|
|
27
|
+
typescript: '~5.8.2',
|
|
28
|
+
vitest: '~4.0.0',
|
|
29
|
+
},
|
|
30
|
+
|
|
31
|
+
scripts: {
|
|
32
|
+
dev: 'gkm dev',
|
|
33
|
+
build: 'gkm build --provider aws-apigatewayv2',
|
|
34
|
+
test: 'vitest',
|
|
35
|
+
'test:once': 'vitest run',
|
|
36
|
+
typecheck: 'tsc --noEmit',
|
|
37
|
+
lint: 'biome lint .',
|
|
38
|
+
fmt: 'biome format . --write',
|
|
39
|
+
'fmt:check': 'biome format .',
|
|
40
|
+
},
|
|
41
|
+
|
|
42
|
+
files: (options: TemplateOptions): GeneratedFile[] => {
|
|
43
|
+
const files: GeneratedFile[] = [
|
|
44
|
+
// src/config/env.ts
|
|
45
|
+
{
|
|
46
|
+
path: 'src/config/env.ts',
|
|
47
|
+
content: `import { EnvironmentParser } from '@geekmidas/envkit';
|
|
48
|
+
|
|
49
|
+
export const envParser = new EnvironmentParser(process.env);
|
|
50
|
+
|
|
51
|
+
export const config = envParser
|
|
52
|
+
.create((get) => ({
|
|
53
|
+
stage: get('STAGE').string().default('dev'),
|
|
54
|
+
region: get('AWS_REGION').string().default('us-east-1'),${
|
|
55
|
+
options.database
|
|
56
|
+
? `
|
|
57
|
+
database: {
|
|
58
|
+
url: get('DATABASE_URL').string(),
|
|
59
|
+
},`
|
|
60
|
+
: ''
|
|
61
|
+
}
|
|
62
|
+
}))
|
|
63
|
+
.parse();
|
|
64
|
+
`,
|
|
65
|
+
},
|
|
66
|
+
|
|
67
|
+
// src/config/logger.ts - using pino
|
|
68
|
+
{
|
|
69
|
+
path: 'src/config/logger.ts',
|
|
70
|
+
content: `import { PinoLogger } from '@geekmidas/logger/pino';
|
|
71
|
+
|
|
72
|
+
export const logger = new PinoLogger({
|
|
73
|
+
app: '${options.name}',
|
|
74
|
+
stage: process.env.STAGE || 'dev',
|
|
75
|
+
level: process.env.LOG_LEVEL || 'info',
|
|
76
|
+
});
|
|
77
|
+
`,
|
|
78
|
+
},
|
|
79
|
+
|
|
80
|
+
// src/endpoints/health.ts
|
|
81
|
+
{
|
|
82
|
+
path: 'src/endpoints/health.ts',
|
|
83
|
+
content: `import { e } from '@geekmidas/constructs/endpoints';
|
|
84
|
+
|
|
85
|
+
export default e
|
|
86
|
+
.get('/health')
|
|
87
|
+
.handle(async () => ({
|
|
88
|
+
status: 'ok',
|
|
89
|
+
timestamp: new Date().toISOString(),
|
|
90
|
+
region: process.env.AWS_REGION || 'local',
|
|
91
|
+
}));
|
|
92
|
+
`,
|
|
93
|
+
},
|
|
94
|
+
|
|
95
|
+
// src/functions/hello.ts
|
|
96
|
+
{
|
|
97
|
+
path: 'src/functions/hello.ts',
|
|
98
|
+
content: `import { f } from '@geekmidas/constructs/functions';
|
|
99
|
+
import { z } from 'zod';
|
|
100
|
+
|
|
101
|
+
export default f
|
|
102
|
+
.input(z.object({ name: z.string() }))
|
|
103
|
+
.output(z.object({ message: z.string() }))
|
|
104
|
+
.handle(async ({ input }) => ({
|
|
105
|
+
message: \`Hello, \${input.name}!\`,
|
|
106
|
+
}));
|
|
107
|
+
`,
|
|
108
|
+
},
|
|
109
|
+
];
|
|
110
|
+
|
|
111
|
+
// Add Telescope config if enabled
|
|
112
|
+
if (options.telescope) {
|
|
113
|
+
files.push({
|
|
114
|
+
path: 'src/config/telescope.ts',
|
|
115
|
+
content: `import { Telescope } from '@geekmidas/telescope';
|
|
116
|
+
import { InMemoryStorage } from '@geekmidas/telescope/storage/memory';
|
|
117
|
+
|
|
118
|
+
// Note: For production Lambda, consider using a persistent storage
|
|
119
|
+
export const telescope = new Telescope({
|
|
120
|
+
storage: new InMemoryStorage({ maxEntries: 50 }),
|
|
121
|
+
enabled: process.env.STAGE === 'dev',
|
|
122
|
+
});
|
|
123
|
+
`,
|
|
124
|
+
});
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
return files;
|
|
128
|
+
},
|
|
129
|
+
};
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
import type {
|
|
2
|
+
GeneratedFile,
|
|
3
|
+
TemplateConfig,
|
|
4
|
+
TemplateOptions,
|
|
5
|
+
} from './index.js';
|
|
6
|
+
|
|
7
|
+
export const workerTemplate: TemplateConfig = {
|
|
8
|
+
name: 'worker',
|
|
9
|
+
description: 'Background job processing',
|
|
10
|
+
|
|
11
|
+
dependencies: {
|
|
12
|
+
'@geekmidas/constructs': 'workspace:*',
|
|
13
|
+
'@geekmidas/envkit': 'workspace:*',
|
|
14
|
+
'@geekmidas/logger': 'workspace:*',
|
|
15
|
+
'@geekmidas/events': 'workspace:*',
|
|
16
|
+
hono: '~4.8.2',
|
|
17
|
+
pino: '~9.6.0',
|
|
18
|
+
},
|
|
19
|
+
|
|
20
|
+
devDependencies: {
|
|
21
|
+
'@biomejs/biome': '~1.9.4',
|
|
22
|
+
'@geekmidas/cli': 'workspace:*',
|
|
23
|
+
'@types/node': '~22.0.0',
|
|
24
|
+
tsx: '~4.20.0',
|
|
25
|
+
turbo: '~2.3.0',
|
|
26
|
+
typescript: '~5.8.2',
|
|
27
|
+
vitest: '~4.0.0',
|
|
28
|
+
},
|
|
29
|
+
|
|
30
|
+
scripts: {
|
|
31
|
+
dev: 'gkm dev',
|
|
32
|
+
build: 'gkm build',
|
|
33
|
+
test: 'vitest',
|
|
34
|
+
'test:once': 'vitest run',
|
|
35
|
+
typecheck: 'tsc --noEmit',
|
|
36
|
+
lint: 'biome lint .',
|
|
37
|
+
fmt: 'biome format . --write',
|
|
38
|
+
'fmt:check': 'biome format .',
|
|
39
|
+
},
|
|
40
|
+
|
|
41
|
+
files: (options: TemplateOptions): GeneratedFile[] => {
|
|
42
|
+
const files: GeneratedFile[] = [
|
|
43
|
+
// src/config/env.ts
|
|
44
|
+
{
|
|
45
|
+
path: 'src/config/env.ts',
|
|
46
|
+
content: `import { EnvironmentParser } from '@geekmidas/envkit';
|
|
47
|
+
|
|
48
|
+
export const envParser = new EnvironmentParser(process.env);
|
|
49
|
+
|
|
50
|
+
export const config = envParser
|
|
51
|
+
.create((get) => ({
|
|
52
|
+
port: get('PORT').string().transform(Number).default(3000),
|
|
53
|
+
nodeEnv: get('NODE_ENV').string().default('development'),
|
|
54
|
+
rabbitmq: {
|
|
55
|
+
url: get('RABBITMQ_URL').string().default('amqp://localhost:5672'),
|
|
56
|
+
},${
|
|
57
|
+
options.database
|
|
58
|
+
? `
|
|
59
|
+
database: {
|
|
60
|
+
url: get('DATABASE_URL').string().default('postgresql://localhost:5432/mydb'),
|
|
61
|
+
},`
|
|
62
|
+
: ''
|
|
63
|
+
}
|
|
64
|
+
}))
|
|
65
|
+
.parse();
|
|
66
|
+
`,
|
|
67
|
+
},
|
|
68
|
+
|
|
69
|
+
// src/config/logger.ts - using pino
|
|
70
|
+
{
|
|
71
|
+
path: 'src/config/logger.ts',
|
|
72
|
+
content: `import { PinoLogger } from '@geekmidas/logger/pino';
|
|
73
|
+
|
|
74
|
+
export const logger = new PinoLogger({
|
|
75
|
+
app: '${options.name}',
|
|
76
|
+
level: process.env.LOG_LEVEL || 'info',
|
|
77
|
+
});
|
|
78
|
+
`,
|
|
79
|
+
},
|
|
80
|
+
|
|
81
|
+
// src/endpoints/health.ts
|
|
82
|
+
{
|
|
83
|
+
path: 'src/endpoints/health.ts',
|
|
84
|
+
content: `import { e } from '@geekmidas/constructs/endpoints';
|
|
85
|
+
|
|
86
|
+
export default e
|
|
87
|
+
.get('/health')
|
|
88
|
+
.handle(async () => ({
|
|
89
|
+
status: 'ok',
|
|
90
|
+
timestamp: new Date().toISOString(),
|
|
91
|
+
}));
|
|
92
|
+
`,
|
|
93
|
+
},
|
|
94
|
+
|
|
95
|
+
// src/events/types.ts
|
|
96
|
+
{
|
|
97
|
+
path: 'src/events/types.ts',
|
|
98
|
+
content: `import type { PublishableMessage } from '@geekmidas/events';
|
|
99
|
+
|
|
100
|
+
// Define your event types here
|
|
101
|
+
export type AppEvents =
|
|
102
|
+
| PublishableMessage<'user.created', { userId: string; email: string }>
|
|
103
|
+
| PublishableMessage<'user.updated', { userId: string; changes: Record<string, unknown> }>
|
|
104
|
+
| PublishableMessage<'order.placed', { orderId: string; userId: string; total: number }>;
|
|
105
|
+
`,
|
|
106
|
+
},
|
|
107
|
+
|
|
108
|
+
// src/subscribers/user-events.ts
|
|
109
|
+
{
|
|
110
|
+
path: 'src/subscribers/user-events.ts',
|
|
111
|
+
content: `import { s } from '@geekmidas/constructs/subscribers';
|
|
112
|
+
import type { AppEvents } from '../events/types.js';
|
|
113
|
+
|
|
114
|
+
export default s<AppEvents>()
|
|
115
|
+
.events(['user.created', 'user.updated'])
|
|
116
|
+
.handle(async ({ event, logger }) => {
|
|
117
|
+
logger.info({ type: event.type, payload: event.payload }, 'Processing user event');
|
|
118
|
+
|
|
119
|
+
switch (event.type) {
|
|
120
|
+
case 'user.created':
|
|
121
|
+
// Handle user creation
|
|
122
|
+
logger.info({ userId: event.payload.userId }, 'New user created');
|
|
123
|
+
break;
|
|
124
|
+
case 'user.updated':
|
|
125
|
+
// Handle user update
|
|
126
|
+
logger.info({ userId: event.payload.userId }, 'User updated');
|
|
127
|
+
break;
|
|
128
|
+
}
|
|
129
|
+
});
|
|
130
|
+
`,
|
|
131
|
+
},
|
|
132
|
+
|
|
133
|
+
// src/crons/cleanup.ts
|
|
134
|
+
{
|
|
135
|
+
path: 'src/crons/cleanup.ts',
|
|
136
|
+
content: `import { cron } from '@geekmidas/constructs/crons';
|
|
137
|
+
|
|
138
|
+
// Run every day at midnight
|
|
139
|
+
export default cron('0 0 * * *')
|
|
140
|
+
.handle(async ({ logger }) => {
|
|
141
|
+
logger.info('Running cleanup job');
|
|
142
|
+
|
|
143
|
+
// Add your cleanup logic here
|
|
144
|
+
// e.g., delete old sessions, clean up temp files, etc.
|
|
145
|
+
|
|
146
|
+
logger.info('Cleanup job completed');
|
|
147
|
+
});
|
|
148
|
+
`,
|
|
149
|
+
},
|
|
150
|
+
];
|
|
151
|
+
|
|
152
|
+
// Add Telescope config if enabled
|
|
153
|
+
if (options.telescope) {
|
|
154
|
+
files.push({
|
|
155
|
+
path: 'src/config/telescope.ts',
|
|
156
|
+
content: `import { Telescope } from '@geekmidas/telescope';
|
|
157
|
+
import { InMemoryStorage } from '@geekmidas/telescope/storage/memory';
|
|
158
|
+
|
|
159
|
+
export const telescope = new Telescope({
|
|
160
|
+
storage: new InMemoryStorage({ maxEntries: 100 }),
|
|
161
|
+
enabled: process.env.NODE_ENV === 'development',
|
|
162
|
+
});
|
|
163
|
+
`,
|
|
164
|
+
});
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
return files;
|
|
168
|
+
},
|
|
169
|
+
};
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { existsSync } from 'node:fs';
|
|
2
|
+
import { join } from 'node:path';
|
|
3
|
+
|
|
4
|
+
export type PackageManager = 'pnpm' | 'npm' | 'yarn' | 'bun';
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Detect the package manager being used based on lockfiles or npm_config_user_agent
|
|
8
|
+
*/
|
|
9
|
+
export function detectPackageManager(
|
|
10
|
+
cwd: string = process.cwd(),
|
|
11
|
+
): PackageManager {
|
|
12
|
+
// Check for lockfiles in cwd
|
|
13
|
+
if (existsSync(join(cwd, 'pnpm-lock.yaml'))) return 'pnpm';
|
|
14
|
+
if (existsSync(join(cwd, 'yarn.lock'))) return 'yarn';
|
|
15
|
+
if (existsSync(join(cwd, 'bun.lockb'))) return 'bun';
|
|
16
|
+
if (existsSync(join(cwd, 'package-lock.json'))) return 'npm';
|
|
17
|
+
|
|
18
|
+
// Check npm_config_user_agent (set when running via npx/pnpm dlx/etc)
|
|
19
|
+
const userAgent = process.env.npm_config_user_agent || '';
|
|
20
|
+
if (userAgent.includes('pnpm')) return 'pnpm';
|
|
21
|
+
if (userAgent.includes('yarn')) return 'yarn';
|
|
22
|
+
if (userAgent.includes('bun')) return 'bun';
|
|
23
|
+
|
|
24
|
+
return 'npm';
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Validate project name for npm package naming conventions
|
|
29
|
+
*/
|
|
30
|
+
export function validateProjectName(name: string): boolean | string {
|
|
31
|
+
if (!name) {
|
|
32
|
+
return 'Project name is required';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
// Check for valid npm package name characters
|
|
36
|
+
if (!/^[a-z0-9-_@/.]+$/i.test(name)) {
|
|
37
|
+
return 'Project name can only contain letters, numbers, hyphens, underscores, @, /, and .';
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
// Check for reserved names
|
|
41
|
+
const reserved = ['node_modules', '.git', 'package.json', 'src'];
|
|
42
|
+
if (reserved.includes(name.toLowerCase())) {
|
|
43
|
+
return `"${name}" is a reserved name`;
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
return true;
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
/**
|
|
50
|
+
* Check if a directory already exists at the target path
|
|
51
|
+
*/
|
|
52
|
+
export function checkDirectoryExists(
|
|
53
|
+
name: string,
|
|
54
|
+
cwd: string = process.cwd(),
|
|
55
|
+
): boolean | string {
|
|
56
|
+
const targetPath = join(cwd, name);
|
|
57
|
+
if (existsSync(targetPath)) {
|
|
58
|
+
return `Directory "${name}" already exists`;
|
|
59
|
+
}
|
|
60
|
+
return true;
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* Get the install command for a package manager
|
|
65
|
+
*/
|
|
66
|
+
export function getInstallCommand(pkgManager: PackageManager): string {
|
|
67
|
+
switch (pkgManager) {
|
|
68
|
+
case 'pnpm':
|
|
69
|
+
return 'pnpm install';
|
|
70
|
+
case 'yarn':
|
|
71
|
+
return 'yarn';
|
|
72
|
+
case 'bun':
|
|
73
|
+
return 'bun install';
|
|
74
|
+
case 'npm':
|
|
75
|
+
default:
|
|
76
|
+
return 'npm install';
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Get the dev command for a package manager
|
|
82
|
+
*/
|
|
83
|
+
export function getRunCommand(
|
|
84
|
+
pkgManager: PackageManager,
|
|
85
|
+
script: string,
|
|
86
|
+
): string {
|
|
87
|
+
switch (pkgManager) {
|
|
88
|
+
case 'pnpm':
|
|
89
|
+
return `pnpm ${script}`;
|
|
90
|
+
case 'yarn':
|
|
91
|
+
return `yarn ${script}`;
|
|
92
|
+
case 'bun':
|
|
93
|
+
return `bun run ${script}`;
|
|
94
|
+
case 'npm':
|
|
95
|
+
default:
|
|
96
|
+
return `npm run ${script}`;
|
|
97
|
+
}
|
|
98
|
+
}
|
package/src/openapi.ts
CHANGED
|
@@ -1,13 +1,16 @@
|
|
|
1
1
|
#!/usr/bin/env -S npx tsx
|
|
2
2
|
|
|
3
3
|
import { mkdir, writeFile } from 'node:fs/promises';
|
|
4
|
-
import { join } from 'node:path';
|
|
4
|
+
import { dirname, join } from 'node:path';
|
|
5
5
|
import { Endpoint } from '@geekmidas/constructs/endpoints';
|
|
6
6
|
import { loadConfig } from './config.js';
|
|
7
7
|
import { EndpointGenerator } from './generators/EndpointGenerator.js';
|
|
8
|
+
import { OpenApiTsGenerator } from './generators/OpenApiTsGenerator.js';
|
|
8
9
|
|
|
9
10
|
interface OpenAPIOptions {
|
|
10
11
|
output?: string;
|
|
12
|
+
json?: boolean;
|
|
13
|
+
cwd?: string;
|
|
11
14
|
}
|
|
12
15
|
|
|
13
16
|
export async function openapiCommand(
|
|
@@ -17,11 +20,11 @@ export async function openapiCommand(
|
|
|
17
20
|
|
|
18
21
|
try {
|
|
19
22
|
// Load config using existing function
|
|
20
|
-
const config = await loadConfig();
|
|
21
|
-
const
|
|
23
|
+
const config = await loadConfig(options.cwd);
|
|
24
|
+
const endpointGenerator = new EndpointGenerator();
|
|
22
25
|
|
|
23
26
|
// Load all endpoints using the refactored function
|
|
24
|
-
const loadedEndpoints = await
|
|
27
|
+
const loadedEndpoints = await endpointGenerator.load(config.routes);
|
|
25
28
|
|
|
26
29
|
if (loadedEndpoints.length === 0) {
|
|
27
30
|
logger.log('No valid endpoints found');
|
|
@@ -31,19 +34,37 @@ export async function openapiCommand(
|
|
|
31
34
|
// Extract just the endpoint instances for OpenAPI generation
|
|
32
35
|
const endpoints = loadedEndpoints.map(({ construct }) => construct);
|
|
33
36
|
|
|
34
|
-
//
|
|
35
|
-
const
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
description: 'Auto-generated API documentation from endpoints',
|
|
39
|
-
});
|
|
37
|
+
// Determine output format (TypeScript is default)
|
|
38
|
+
const isJson = options.json === true;
|
|
39
|
+
const defaultOutput = isJson ? 'openapi.json' : 'openapi.ts';
|
|
40
|
+
const outputPath = options.output || join(process.cwd(), defaultOutput);
|
|
40
41
|
|
|
41
|
-
//
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
42
|
+
// Ensure output directory exists
|
|
43
|
+
await mkdir(dirname(outputPath), { recursive: true });
|
|
44
|
+
|
|
45
|
+
if (isJson) {
|
|
46
|
+
// Generate JSON OpenAPI spec (legacy)
|
|
47
|
+
const spec = await Endpoint.buildOpenApiSchema(endpoints, {
|
|
48
|
+
title: 'API Documentation',
|
|
49
|
+
version: '1.0.0',
|
|
50
|
+
description: 'Auto-generated API documentation from endpoints',
|
|
51
|
+
});
|
|
52
|
+
|
|
53
|
+
await writeFile(outputPath, JSON.stringify(spec, null, 2));
|
|
54
|
+
logger.log(`OpenAPI JSON spec generated: ${outputPath}`);
|
|
55
|
+
} else {
|
|
56
|
+
// Generate TypeScript OpenAPI module (default)
|
|
57
|
+
const tsGenerator = new OpenApiTsGenerator();
|
|
58
|
+
const tsContent = await tsGenerator.generate(endpoints, {
|
|
59
|
+
title: 'API Documentation',
|
|
60
|
+
version: '1.0.0',
|
|
61
|
+
description: 'Auto-generated API documentation from endpoints',
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
await writeFile(outputPath, tsContent);
|
|
65
|
+
logger.log(`OpenAPI TypeScript module generated: ${outputPath}`);
|
|
66
|
+
}
|
|
45
67
|
|
|
46
|
-
logger.log(`OpenAPI spec generated: ${outputPath}`);
|
|
47
68
|
logger.log(`Found ${endpoints.length} endpoints`);
|
|
48
69
|
} catch (error) {
|
|
49
70
|
throw new Error(`OpenAPI generation failed: ${(error as Error).message}`);
|
package/src/types.ts
CHANGED
|
@@ -25,6 +25,25 @@ export interface ServerConfig extends ProviderConfig {
|
|
|
25
25
|
port?: number;
|
|
26
26
|
}
|
|
27
27
|
|
|
28
|
+
export type Runtime = 'node' | 'bun';
|
|
29
|
+
|
|
30
|
+
export interface TelescopeConfig {
|
|
31
|
+
/** Enable/disable telescope (default: true in development) */
|
|
32
|
+
enabled?: boolean;
|
|
33
|
+
/** Port for telescope to use (defaults to server port) */
|
|
34
|
+
port?: number;
|
|
35
|
+
/** Path prefix for telescope UI (default: /__telescope) */
|
|
36
|
+
path?: string;
|
|
37
|
+
/** Ignore patterns for telescope (e.g., ['/health', '/metrics']) */
|
|
38
|
+
ignore?: string[];
|
|
39
|
+
/** Record request/response bodies (default: true) */
|
|
40
|
+
recordBody?: boolean;
|
|
41
|
+
/** Maximum entries to keep in memory (default: 1000) */
|
|
42
|
+
maxEntries?: number;
|
|
43
|
+
/** Enable WebSocket for real-time updates (default: true, requires @hono/node-ws for Node.js) */
|
|
44
|
+
websocket?: boolean;
|
|
45
|
+
}
|
|
46
|
+
|
|
28
47
|
export interface ProvidersConfig {
|
|
29
48
|
aws?: {
|
|
30
49
|
apiGateway?: {
|
|
@@ -47,6 +66,30 @@ export interface GkmConfig {
|
|
|
47
66
|
envParser: string;
|
|
48
67
|
logger: string;
|
|
49
68
|
providers?: ProvidersConfig;
|
|
69
|
+
/**
|
|
70
|
+
* Telescope configuration for debugging/monitoring.
|
|
71
|
+
* Can be:
|
|
72
|
+
* - A string path to a module that exports a Telescope instance (recommended)
|
|
73
|
+
* - A boolean to enable/disable with defaults
|
|
74
|
+
* - A TelescopeConfig object for inline configuration
|
|
75
|
+
*/
|
|
76
|
+
telescope?: string | boolean | TelescopeConfig;
|
|
77
|
+
/** Runtime to use for dev server (default: 'node') */
|
|
78
|
+
runtime?: Runtime;
|
|
79
|
+
/**
|
|
80
|
+
* Environment file(s) to load for development.
|
|
81
|
+
* Can be:
|
|
82
|
+
* - A string path to a single env file (e.g., '.env.local')
|
|
83
|
+
* - An array of paths to load in order (later files override earlier)
|
|
84
|
+
* - Defaults to '.env' if not specified
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* env: '.env.local'
|
|
88
|
+
*
|
|
89
|
+
* @example
|
|
90
|
+
* env: ['.env', '.env.local']
|
|
91
|
+
*/
|
|
92
|
+
env?: string | string[];
|
|
50
93
|
}
|
|
51
94
|
|
|
52
95
|
export interface BuildOptions {
|
package/tsdown.config.ts
CHANGED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"EndpointGenerator-C73wNoih.cjs","names":["ConstructGenerator","value: any","context: BuildContext","constructs: GeneratedConstruct<\n Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >\n >[]","outputDir: string","options?: GeneratorOptions","routes: RouteInfo[]","routeInfo: RouteInfo","sourceFile: string","exportName: string","provider: LegacyProvider","_endpoint: Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >","content: string","endpoints: GeneratedConstruct<\n Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >\n >[]","exports","importPath: string","envParserPath: string","envParserImportPattern: string"],"sources":["../src/generators/EndpointGenerator.ts"],"sourcesContent":["import { mkdir, writeFile } from 'node:fs/promises';\nimport { dirname, join, relative } from 'node:path';\nimport { Endpoint } from '@geekmidas/constructs/endpoints';\nimport type { BuildContext } from '../build/types';\nimport type { LegacyProvider, RouteInfo } from '../types';\nimport {\n ConstructGenerator,\n type GeneratedConstruct,\n type GeneratorOptions,\n} from './Generator';\n\nexport class EndpointGenerator extends ConstructGenerator<\n Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >,\n RouteInfo[]\n> {\n isConstruct(\n value: any,\n ): value is Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n > {\n return Endpoint.isEndpoint(value);\n }\n\n async build(\n context: BuildContext,\n constructs: GeneratedConstruct<\n Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >\n >[],\n outputDir: string,\n options?: GeneratorOptions,\n ): Promise<RouteInfo[]> {\n const provider = options?.provider || 'aws-apigatewayv2';\n const enableOpenApi = options?.enableOpenApi || false;\n const logger = console;\n const routes: RouteInfo[] = [];\n\n if (constructs.length === 0) {\n return routes;\n }\n\n if (provider === 'server') {\n // Generate endpoints.ts and app.ts\n await this.generateEndpointsFile(outputDir, constructs, context);\n const appFile = await this.generateAppFile(outputDir, context);\n\n routes.push({\n path: '*',\n method: 'ALL',\n handler: relative(process.cwd(), appFile),\n authorizer: 'none',\n });\n\n logger.log(\n `Generated server with ${constructs.length} endpoints${enableOpenApi ? ' (OpenAPI enabled)' : ''}`,\n );\n } else if (provider === 'aws-lambda') {\n // For aws-lambda, create routes subdirectory\n const routesDir = join(outputDir, 'routes');\n await mkdir(routesDir, { recursive: true });\n\n // Generate individual handlers for API Gateway routes\n for (const { key, construct, path } of constructs) {\n const handlerFile = await this.generateHandlerFile(\n routesDir,\n path.relative,\n key,\n 'aws-apigatewayv2',\n construct,\n context,\n );\n\n const routeInfo: RouteInfo = {\n path: construct._path,\n method: construct.method,\n handler: relative(process.cwd(), handlerFile).replace(\n /\\.ts$/,\n '.handler',\n ),\n timeout: construct.timeout,\n memorySize: construct.memorySize,\n environment: await construct.getEnvironment(),\n authorizer: construct.authorizer?.name ?? 'none',\n };\n\n routes.push(routeInfo);\n logger.log(\n `Generated handler for ${routeInfo.method} ${routeInfo.path}`,\n );\n }\n } else {\n // Generate individual handler files for AWS API Gateway providers\n for (const { key, construct, path } of constructs) {\n const handlerFile = await this.generateHandlerFile(\n outputDir,\n path.relative,\n key,\n provider,\n construct,\n context,\n );\n\n const routeInfo: RouteInfo = {\n path: construct._path,\n method: construct.method,\n handler: relative(process.cwd(), handlerFile).replace(\n /\\.ts$/,\n '.handler',\n ),\n timeout: construct.timeout,\n memorySize: construct.memorySize,\n environment: await construct.getEnvironment(),\n authorizer: construct.authorizer?.name ?? 'none',\n };\n\n routes.push(routeInfo);\n logger.log(\n `Generated handler for ${routeInfo.method} ${routeInfo.path}`,\n );\n }\n }\n\n return routes;\n }\n\n private async generateHandlerFile(\n outputDir: string,\n sourceFile: string,\n exportName: string,\n provider: LegacyProvider,\n _endpoint: Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >,\n context: BuildContext,\n ): Promise<string> {\n const handlerFileName = `${exportName}.ts`;\n const handlerPath = join(outputDir, handlerFileName);\n\n const relativePath = relative(dirname(handlerPath), sourceFile);\n const importPath = relativePath.replace(/\\.ts$/, '.js');\n\n const relativeEnvParserPath = relative(\n dirname(handlerPath),\n context.envParserPath,\n );\n\n let content: string;\n\n switch (provider) {\n case 'aws-apigatewayv1':\n content = this.generateAWSApiGatewayV1Handler(\n importPath,\n exportName,\n relativeEnvParserPath,\n context.envParserImportPattern,\n );\n break;\n case 'aws-apigatewayv2':\n content = this.generateAWSApiGatewayV2Handler(\n importPath,\n exportName,\n relativeEnvParserPath,\n context.envParserImportPattern,\n );\n break;\n case 'server':\n content = this.generateServerHandler(importPath, exportName);\n break;\n default:\n throw new Error(`Unsupported provider: ${provider}`);\n }\n\n await writeFile(handlerPath, content);\n return handlerPath;\n }\n\n private async generateEndpointsFile(\n outputDir: string,\n endpoints: GeneratedConstruct<\n Endpoint<\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any,\n any\n >\n >[],\n context: BuildContext,\n ): Promise<string> {\n const endpointsFileName = 'endpoints.ts';\n const endpointsPath = join(outputDir, endpointsFileName);\n\n // Group imports by file\n const importsByFile = new Map<string, string[]>();\n\n for (const { path, key } of endpoints) {\n const relativePath = relative(dirname(endpointsPath), path.relative);\n const importPath = relativePath.replace(/\\.ts$/, '.js');\n\n if (!importsByFile.has(importPath)) {\n importsByFile.set(importPath, []);\n }\n importsByFile.get(importPath)!.push(key);\n }\n\n // Generate import statements\n const imports = Array.from(importsByFile.entries())\n .map(\n ([importPath, exports]) =>\n `import { ${exports.join(', ')} } from '${importPath}';`,\n )\n .join('\\n');\n\n const allExportNames = endpoints.map(({ key }) => key);\n\n const content = `import type { EnvironmentParser } from '@geekmidas/envkit';\nimport type { Logger } from '@geekmidas/logger';\nimport { HonoEndpoint } from '@geekmidas/constructs/hono';\nimport { Endpoint } from '@geekmidas/constructs/endpoints';\nimport { ServiceDiscovery } from '@geekmidas/services';\nimport type { Hono } from 'hono';\n${imports}\n\nconst endpoints: Endpoint<any, any, any, any, any, any, any, any, any, any, any, any, any, any>[] = [\n ${allExportNames.join(',\\n ')}\n];\n\nexport function setupEndpoints(\n app: Hono,\n envParser: EnvironmentParser<any>,\n logger: Logger,\n enableOpenApi: boolean = true,\n): void {\n const serviceDiscovery = ServiceDiscovery.getInstance(\n logger,\n envParser\n );\n\n // Configure OpenAPI options based on enableOpenApi flag\n const openApiOptions: any = enableOpenApi ? {\n docsPath: '/docs',\n openApiOptions: {\n title: 'API Documentation',\n version: '1.0.0',\n description: 'Generated API documentation'\n }\n } : { docsPath: false };\n\n HonoEndpoint.addRoutes(endpoints, serviceDiscovery, app, openApiOptions);\n}\n`;\n\n await writeFile(endpointsPath, content);\n\n return endpointsPath;\n }\n\n private async generateAppFile(\n outputDir: string,\n context: BuildContext,\n ): Promise<string> {\n const appFileName = 'app.ts';\n const appPath = join(outputDir, appFileName);\n\n const relativeLoggerPath = relative(dirname(appPath), context.loggerPath);\n\n const relativeEnvParserPath = relative(\n dirname(appPath),\n context.envParserPath,\n );\n\n const content = `/**\n * Generated server application\n *\n * ⚠️ WARNING: This is for LOCAL DEVELOPMENT ONLY\n * The subscriber polling mechanism is not production-ready.\n * For production, use AWS Lambda with SQS/SNS event sources.\n */\nimport { Hono } from 'hono';\nimport type { Hono as HonoType } from 'hono';\nimport { setupEndpoints } from './endpoints.js';\nimport { setupSubscribers } from './subscribers.js';\nimport ${context.envParserImportPattern} from '${relativeEnvParserPath}';\nimport ${context.loggerImportPattern} from '${relativeLoggerPath}';\n\nexport interface ServerApp {\n app: HonoType;\n start: (options?: {\n port?: number;\n serve: (app: HonoType, port: number) => void | Promise<void>;\n }) => Promise<void>;\n}\n\n/**\n * Create and configure the Hono application\n *\n * @param app - Optional Hono app instance to configure (creates new one if not provided)\n * @param enableOpenApi - Enable OpenAPI documentation (default: true)\n * @returns Server app with configured Hono app and start function\n *\n * @example\n * // With Bun\n * import { createApp } from './.gkm/server/app.js';\n *\n * const { app, start } = createApp();\n *\n * await start({\n * port: 3000,\n * serve: (app, port) => {\n * Bun.serve({ port, fetch: app.fetch });\n * }\n * });\n *\n * @example\n * // With Node.js (using @hono/node-server)\n * import { serve } from '@hono/node-server';\n * import { createApp } from './.gkm/server/app.js';\n *\n * const { app, start } = createApp();\n *\n * await start({\n * port: 3000,\n * serve: (app, port) => {\n * serve({ fetch: app.fetch, port });\n * }\n * });\n */\nexport function createApp(app?: HonoType, enableOpenApi: boolean = true): ServerApp {\n const honoApp = app || new Hono();\n\n // Setup HTTP endpoints\n setupEndpoints(honoApp, envParser, logger, enableOpenApi);\n\n return {\n app: honoApp,\n async start(options) {\n if (!options?.serve) {\n throw new Error(\n 'serve function is required. Pass a serve function for your runtime:\\\\n' +\n ' - Bun: (app, port) => Bun.serve({ port, fetch: app.fetch })\\\\n' +\n ' - Node: (app, port) => serve({ fetch: app.fetch, port })'\n );\n }\n\n const port = options.port ?? 3000;\n\n // Start subscribers in background (non-blocking, local development only)\n await setupSubscribers(envParser, logger).catch((error) => {\n logger.error({ error }, 'Failed to start subscribers');\n });\n\n logger.info({ port }, 'Starting server');\n\n // Start HTTP server using provided serve function\n await options.serve(honoApp, port);\n\n logger.info({ port }, 'Server started');\n }\n };\n}\n\n// Default export for convenience\nexport default createApp;\n`;\n\n await writeFile(appPath, content);\n\n return appPath;\n }\n\n private generateAWSApiGatewayV1Handler(\n importPath: string,\n exportName: string,\n envParserPath: string,\n envParserImportPattern: string,\n ): string {\n return `import { AmazonApiGatewayV1Endpoint } from '@geekmidas/constructs/aws';\nimport { ${exportName} } from '${importPath}';\nimport ${envParserImportPattern} from '${envParserPath}';\n\nconst adapter = new AmazonApiGatewayV1Endpoint(envParser, ${exportName});\n\nexport const handler = adapter.handler;\n`;\n }\n\n private generateAWSApiGatewayV2Handler(\n importPath: string,\n exportName: string,\n envParserPath: string,\n envParserImportPattern: string,\n ): string {\n return `import { AmazonApiGatewayV2Endpoint } from '@geekmidas/constructs/aws';\nimport { ${exportName} } from '${importPath}';\nimport ${envParserImportPattern} from '${envParserPath}';\n\nconst adapter = new AmazonApiGatewayV2Endpoint(envParser, ${exportName});\n\nexport const handler = adapter.handler;\n`;\n }\n\n private generateServerHandler(\n importPath: string,\n exportName: string,\n ): string {\n return `import { ${exportName} } from '${importPath}';\n\n// Server handler - implement based on your server framework\nexport const handler = ${exportName};\n`;\n }\n}\n"],"mappings":";;;;;;;AAWA,IAAa,oBAAb,cAAuCA,qCAkBrC;CACA,YACEC,OAgBA;AACA,SAAO,0CAAS,WAAW,MAAM;CAClC;CAED,MAAM,MACJC,SACAC,YAkBAC,WACAC,SACsB;EACtB,MAAM,WAAW,SAAS,YAAY;EACtC,MAAM,gBAAgB,SAAS,iBAAiB;EAChD,MAAM,SAAS;EACf,MAAMC,SAAsB,CAAE;AAE9B,MAAI,WAAW,WAAW,EACxB,QAAO;AAGT,MAAI,aAAa,UAAU;AAEzB,SAAM,KAAK,sBAAsB,WAAW,YAAY,QAAQ;GAChE,MAAM,UAAU,MAAM,KAAK,gBAAgB,WAAW,QAAQ;AAE9D,UAAO,KAAK;IACV,MAAM;IACN,QAAQ;IACR,SAAS,wBAAS,QAAQ,KAAK,EAAE,QAAQ;IACzC,YAAY;GACb,EAAC;AAEF,UAAO,KACJ,wBAAwB,WAAW,OAAO,YAAY,gBAAgB,uBAAuB,GAAG,EAClG;EACF,WAAU,aAAa,cAAc;GAEpC,MAAM,YAAY,oBAAK,WAAW,SAAS;AAC3C,SAAM,4BAAM,WAAW,EAAE,WAAW,KAAM,EAAC;AAG3C,QAAK,MAAM,EAAE,KAAK,WAAW,MAAM,IAAI,YAAY;IACjD,MAAM,cAAc,MAAM,KAAK,oBAC7B,WACA,KAAK,UACL,KACA,oBACA,WACA,QACD;IAED,MAAMC,YAAuB;KAC3B,MAAM,UAAU;KAChB,QAAQ,UAAU;KAClB,SAAS,wBAAS,QAAQ,KAAK,EAAE,YAAY,CAAC,QAC5C,SACA,WACD;KACD,SAAS,UAAU;KACnB,YAAY,UAAU;KACtB,aAAa,MAAM,UAAU,gBAAgB;KAC7C,YAAY,UAAU,YAAY,QAAQ;IAC3C;AAED,WAAO,KAAK,UAAU;AACtB,WAAO,KACJ,wBAAwB,UAAU,OAAO,GAAG,UAAU,KAAK,EAC7D;GACF;EACF,MAEC,MAAK,MAAM,EAAE,KAAK,WAAW,MAAM,IAAI,YAAY;GACjD,MAAM,cAAc,MAAM,KAAK,oBAC7B,WACA,KAAK,UACL,KACA,UACA,WACA,QACD;GAED,MAAMA,YAAuB;IAC3B,MAAM,UAAU;IAChB,QAAQ,UAAU;IAClB,SAAS,wBAAS,QAAQ,KAAK,EAAE,YAAY,CAAC,QAC5C,SACA,WACD;IACD,SAAS,UAAU;IACnB,YAAY,UAAU;IACtB,aAAa,MAAM,UAAU,gBAAgB;IAC7C,YAAY,UAAU,YAAY,QAAQ;GAC3C;AAED,UAAO,KAAK,UAAU;AACtB,UAAO,KACJ,wBAAwB,UAAU,OAAO,GAAG,UAAU,KAAK,EAC7D;EACF;AAGH,SAAO;CACR;CAED,MAAc,oBACZH,WACAI,YACAC,YACAC,UACAC,WAgBAT,SACiB;EACjB,MAAM,mBAAmB,EAAE,WAAW;EACtC,MAAM,cAAc,oBAAK,WAAW,gBAAgB;EAEpD,MAAM,eAAe,wBAAS,uBAAQ,YAAY,EAAE,WAAW;EAC/D,MAAM,aAAa,aAAa,QAAQ,SAAS,MAAM;EAEvD,MAAM,wBAAwB,wBAC5B,uBAAQ,YAAY,EACpB,QAAQ,cACT;EAED,IAAIU;AAEJ,UAAQ,UAAR;GACE,KAAK;AACH,cAAU,KAAK,+BACb,YACA,YACA,uBACA,QAAQ,uBACT;AACD;GACF,KAAK;AACH,cAAU,KAAK,+BACb,YACA,YACA,uBACA,QAAQ,uBACT;AACD;GACF,KAAK;AACH,cAAU,KAAK,sBAAsB,YAAY,WAAW;AAC5D;GACF,QACE,OAAM,IAAI,OAAO,wBAAwB,SAAS;EACrD;AAED,QAAM,gCAAU,aAAa,QAAQ;AACrC,SAAO;CACR;CAED,MAAc,sBACZR,WACAS,WAkBAX,SACiB;EACjB,MAAM,oBAAoB;EAC1B,MAAM,gBAAgB,oBAAK,WAAW,kBAAkB;EAGxD,MAAM,gCAAgB,IAAI;AAE1B,OAAK,MAAM,EAAE,MAAM,KAAK,IAAI,WAAW;GACrC,MAAM,eAAe,wBAAS,uBAAQ,cAAc,EAAE,KAAK,SAAS;GACpE,MAAM,aAAa,aAAa,QAAQ,SAAS,MAAM;AAEvD,QAAK,cAAc,IAAI,WAAW,CAChC,eAAc,IAAI,YAAY,CAAE,EAAC;AAEnC,iBAAc,IAAI,WAAW,CAAE,KAAK,IAAI;EACzC;EAGD,MAAM,UAAU,MAAM,KAAK,cAAc,SAAS,CAAC,CAChD,IACC,CAAC,CAAC,YAAYY,UAAQ,MACnB,WAAW,UAAQ,KAAK,KAAK,CAAC,WAAW,WAAW,IACxD,CACA,KAAK,KAAK;EAEb,MAAM,iBAAiB,UAAU,IAAI,CAAC,EAAE,KAAK,KAAK,IAAI;EAEtD,MAAM,WAAW;;;;;;EAMnB,QAAQ;;;IAGN,eAAe,KAAK,QAAQ,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4B7B,QAAM,gCAAU,eAAe,QAAQ;AAEvC,SAAO;CACR;CAED,MAAc,gBACZV,WACAF,SACiB;EACjB,MAAM,cAAc;EACpB,MAAM,UAAU,oBAAK,WAAW,YAAY;EAE5C,MAAM,qBAAqB,wBAAS,uBAAQ,QAAQ,EAAE,QAAQ,WAAW;EAEzE,MAAM,wBAAwB,wBAC5B,uBAAQ,QAAQ,EAChB,QAAQ,cACT;EAED,MAAM,WAAW;;;;;;;;;;;SAWZ,QAAQ,uBAAuB,SAAS,sBAAsB;SAC9D,QAAQ,oBAAoB,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkF7D,QAAM,gCAAU,SAAS,QAAQ;AAEjC,SAAO;CACR;CAED,AAAQ,+BACNa,YACAN,YACAO,eACAC,wBACQ;AACR,UAAQ;WACD,WAAW,WAAW,WAAW;SACnC,uBAAuB,SAAS,cAAc;;4DAEK,WAAW;;;;CAIpE;CAED,AAAQ,+BACNF,YACAN,YACAO,eACAC,wBACQ;AACR,UAAQ;WACD,WAAW,WAAW,WAAW;SACnC,uBAAuB,SAAS,cAAc;;4DAEK,WAAW;;;;CAIpE;CAED,AAAQ,sBACNF,YACAN,YACQ;AACR,UAAQ,WAAW,WAAW,WAAW,WAAW;;;yBAG/B,WAAW;;CAEjC;AACF"}
|