create-entity-app-server 0.0.3
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/.env.example +68 -0
- package/.gitignore +8 -0
- package/LICENSE +66 -0
- package/README.md +36 -0
- package/bin/create.js +222 -0
- package/configs/cache.json +7 -0
- package/configs/cors.json +24 -0
- package/configs/database.json +30 -0
- package/configs/security.json +45 -0
- package/configs/server.json +31 -0
- package/docs/README.md +274 -0
- package/docs/architecture.md +295 -0
- package/docs/cache.md +217 -0
- package/docs/configs.md +261 -0
- package/docs/database.md +505 -0
- package/docs/design/board-api-design.md +2342 -0
- package/docs/flows.md +581 -0
- package/docs/getting-started.md +83 -0
- package/docs/hooks.md +600 -0
- package/docs/internals.md +60 -0
- package/docs/plugins/2fa.md +121 -0
- package/docs/plugins/alimtalk.md +212 -0
- package/docs/plugins/friendtalk.md +158 -0
- package/docs/plugins/holidays.md +98 -0
- package/docs/plugins/how-to-create.md +148 -0
- package/docs/plugins/identity.md +223 -0
- package/docs/plugins/llm.md +567 -0
- package/docs/plugins/oauth.md +121 -0
- package/docs/plugins/ocr.md +168 -0
- package/docs/plugins/pg.md +226 -0
- package/docs/plugins/push.md +178 -0
- package/docs/plugins/sms.md +228 -0
- package/docs/plugins/taxinvoice.md +197 -0
- package/docs/routes/README.md +247 -0
- package/docs/routes/account-routes.md +262 -0
- package/docs/routes/alimtalk-routes.md +187 -0
- package/docs/routes/board-routes.md +492 -0
- package/docs/routes/email-verification.md +269 -0
- package/docs/routes/friendtalk-routes.md +45 -0
- package/docs/routes/holidays-routes.md +170 -0
- package/docs/routes/how-to-create.md +150 -0
- package/docs/routes/identity-routes.md +310 -0
- package/docs/routes/llm-routes.md +921 -0
- package/docs/routes/ocr-routes.md +133 -0
- package/docs/routes/password-reset.md +234 -0
- package/docs/routes/pg-routes.md +144 -0
- package/docs/routes/push-routes.md +205 -0
- package/docs/routes/sms-routes.md +243 -0
- package/docs/routes/smtp-routes.md +155 -0
- package/docs/routes/tax-invoice-routes.md +109 -0
- package/docs/schedules/dormancy-and-retention.md +160 -0
- package/docs/schedules/how-to-create.md +255 -0
- package/docs/scripts-guide.md +310 -0
- package/docs/security.md +221 -0
- package/docs/system.md +297 -0
- package/package.json +111 -0
- package/scripts/_gen-table-type.ts +605 -0
- package/scripts/build-minify-plugins.mjs +124 -0
- package/scripts/build-obfuscate-system.mjs +38 -0
- package/scripts/build.sh +140 -0
- package/scripts/dist-tsconfig.json +18 -0
- package/scripts/entity.sh +224 -0
- package/scripts/gen-table-type.sh +169 -0
- package/scripts/push.sh +102 -0
- package/scripts/release.sh +51 -0
- package/scripts/reset-all.sh +208 -0
- package/scripts/run.sh +202 -0
- package/src/app/hooks/README.md +148 -0
- package/src/app/hooks/account.ts +26 -0
- package/src/app/hooks/index.ts +19 -0
- package/src/app/hooks/order.ts +230 -0
- package/src/app/hooks/post.ts +162 -0
- package/src/app/plugins/2fa/config.example.json +15 -0
- package/src/app/plugins/2fa/config.json +17 -0
- package/src/app/plugins/2fa/config.ts +44 -0
- package/src/app/plugins/2fa/docs/README.md +139 -0
- package/src/app/plugins/2fa/entities/account.json +30 -0
- package/src/app/plugins/2fa/handlers/disable.ts +114 -0
- package/src/app/plugins/2fa/handlers/index.ts +11 -0
- package/src/app/plugins/2fa/handlers/recovery.ts +98 -0
- package/src/app/plugins/2fa/handlers/regenerate.ts +99 -0
- package/src/app/plugins/2fa/handlers/setup-verify.ts +121 -0
- package/src/app/plugins/2fa/handlers/setup.ts +92 -0
- package/src/app/plugins/2fa/handlers/status.ts +47 -0
- package/src/app/plugins/2fa/handlers/utils.ts +222 -0
- package/src/app/plugins/2fa/handlers/verify.ts +92 -0
- package/src/app/plugins/2fa/index.ts +50 -0
- package/src/app/plugins/2fa/routes.ts +49 -0
- package/src/app/plugins/2fa/templates/auth/2fa_disabled.html +23 -0
- package/src/app/plugins/2fa/templates/auth/2fa_recovery_regenerated.html +31 -0
- package/src/app/plugins/2fa/templates/auth/2fa_setup_complete.html +43 -0
- package/src/app/plugins/2fa/totp-utils.ts +189 -0
- package/src/app/plugins/2fa/types.ts +95 -0
- package/src/app/plugins/README.md +118 -0
- package/src/app/plugins/ais/config.json +7 -0
- package/src/app/plugins/ais/config.ts +32 -0
- package/src/app/plugins/ais/docs/README.md +142 -0
- package/src/app/plugins/ais/docs/api.md +138 -0
- package/src/app/plugins/ais/entities/ais_vessel.json +64 -0
- package/src/app/plugins/ais/handlers.ts +88 -0
- package/src/app/plugins/ais/index.ts +21 -0
- package/src/app/plugins/ais/routes.ts +13 -0
- package/src/app/plugins/ais/service.ts +242 -0
- package/src/app/plugins/ais/types/index.ts +78 -0
- package/src/app/plugins/alimtalk/config.example.json +52 -0
- package/src/app/plugins/alimtalk/config.json +26 -0
- package/src/app/plugins/alimtalk/config.ts +75 -0
- package/src/app/plugins/alimtalk/docs/README.md +140 -0
- package/src/app/plugins/alimtalk/entities/alimtalk_log.json +65 -0
- package/src/app/plugins/alimtalk/entities/alimtalk_msg.json +53 -0
- package/src/app/plugins/alimtalk/entity-adapter.ts +196 -0
- package/src/app/plugins/alimtalk/handlers.ts +84 -0
- package/src/app/plugins/alimtalk/index.ts +80 -0
- package/src/app/plugins/alimtalk/providers/aligo.ts +151 -0
- package/src/app/plugins/alimtalk/providers/index.ts +29 -0
- package/src/app/plugins/alimtalk/providers/nhn.ts +254 -0
- package/src/app/plugins/alimtalk/providers/ppurio.ts +145 -0
- package/src/app/plugins/alimtalk/providers/solapi.ts +145 -0
- package/src/app/plugins/alimtalk/routes.ts +15 -0
- package/src/app/plugins/alimtalk/service.ts +423 -0
- package/src/app/plugins/alimtalk/template-cache.ts +42 -0
- package/src/app/plugins/alimtalk/templates/alimtalk.json +27 -0
- package/src/app/plugins/alimtalk/types/client.ts +48 -0
- package/src/app/plugins/alimtalk/types/config.ts +53 -0
- package/src/app/plugins/alimtalk/types/friendtalk.ts +90 -0
- package/src/app/plugins/alimtalk/types/index.ts +4 -0
- package/src/app/plugins/alimtalk/types/job.ts +56 -0
- package/src/app/plugins/alimtalk/webhook.ts +211 -0
- package/src/app/plugins/distance-server/config.json +6 -0
- package/src/app/plugins/distance-server/config.ts +50 -0
- package/src/app/plugins/distance-server/docs/README.md +114 -0
- package/src/app/plugins/distance-server/handlers.ts +104 -0
- package/src/app/plugins/distance-server/index.ts +23 -0
- package/src/app/plugins/distance-server/routes.ts +36 -0
- package/src/app/plugins/distance-server/service.ts +187 -0
- package/src/app/plugins/distance-server/types/index.ts +8 -0
- package/src/app/plugins/example/config.json +6 -0
- package/src/app/plugins/example/config.ts +46 -0
- package/src/app/plugins/example/docs/README.md +64 -0
- package/src/app/plugins/example/entity-adapter.ts +96 -0
- package/src/app/plugins/example/handlers.ts +94 -0
- package/src/app/plugins/example/index.ts +63 -0
- package/src/app/plugins/example/routes.ts +30 -0
- package/src/app/plugins/example/service.ts +31 -0
- package/src/app/plugins/example/types/config.ts +11 -0
- package/src/app/plugins/example/types/index.ts +1 -0
- package/src/app/plugins/friendtalk/config.example.json +35 -0
- package/src/app/plugins/friendtalk/config.json +11 -0
- package/src/app/plugins/friendtalk/config.ts +70 -0
- package/src/app/plugins/friendtalk/docs/README.md +110 -0
- package/src/app/plugins/friendtalk/entities/friendtalk_log.json +89 -0
- package/src/app/plugins/friendtalk/entities/friendtalk_msg.json +91 -0
- package/src/app/plugins/friendtalk/entity-adapter.ts +150 -0
- package/src/app/plugins/friendtalk/handlers.ts +56 -0
- package/src/app/plugins/friendtalk/routes.ts +12 -0
- package/src/app/plugins/friendtalk/templates/friendtalk.json +16 -0
- package/src/app/plugins/holidays/config.example.json +6 -0
- package/src/app/plugins/holidays/config.json +10 -0
- package/src/app/plugins/holidays/config.ts +44 -0
- package/src/app/plugins/holidays/docs/README.md +122 -0
- package/src/app/plugins/holidays/entities/holiday.json +22 -0
- package/src/app/plugins/holidays/handlers.ts +135 -0
- package/src/app/plugins/holidays/index.ts +78 -0
- package/src/app/plugins/holidays/routes.ts +18 -0
- package/src/app/plugins/holidays/service.ts +241 -0
- package/src/app/plugins/holidays/types/api.ts +49 -0
- package/src/app/plugins/holidays/types/config.ts +8 -0
- package/src/app/plugins/holidays/types/index.ts +2 -0
- package/src/app/plugins/identity/config.example.json +43 -0
- package/src/app/plugins/identity/config.json +30 -0
- package/src/app/plugins/identity/config.ts +138 -0
- package/src/app/plugins/identity/crypto.ts +51 -0
- package/src/app/plugins/identity/docs/README.md +164 -0
- package/src/app/plugins/identity/entities/account.json +27 -0
- package/src/app/plugins/identity/entities/identity_verification.json +113 -0
- package/src/app/plugins/identity/entity-adapter.ts +242 -0
- package/src/app/plugins/identity/handlers.ts +239 -0
- package/src/app/plugins/identity/index.ts +80 -0
- package/src/app/plugins/identity/providers/danal.ts +150 -0
- package/src/app/plugins/identity/providers/index.ts +38 -0
- package/src/app/plugins/identity/providers/kmc.ts +140 -0
- package/src/app/plugins/identity/providers/nice.ts +304 -0
- package/src/app/plugins/identity/routes.ts +22 -0
- package/src/app/plugins/identity/service.ts +361 -0
- package/src/app/plugins/identity/types/config.ts +35 -0
- package/src/app/plugins/identity/types/index.ts +2 -0
- package/src/app/plugins/identity/types/verification.ts +105 -0
- package/src/app/plugins/kobc_freight/config.json +6 -0
- package/src/app/plugins/kobc_freight/config.ts +28 -0
- package/src/app/plugins/kobc_freight/docs/README.md +316 -0
- package/src/app/plugins/kobc_freight/entities/kobc_freight_entry.json +31 -0
- package/src/app/plugins/kobc_freight/entities/kobc_kcci_entry.json +67 -0
- package/src/app/plugins/kobc_freight/entities/kobc_kpli_entry.json +27 -0
- package/src/app/plugins/kobc_freight/entities/kobc_ncfi_entry.json +99 -0
- package/src/app/plugins/kobc_freight/handlers.ts +283 -0
- package/src/app/plugins/kobc_freight/index.ts +21 -0
- package/src/app/plugins/kobc_freight/routes.ts +39 -0
- package/src/app/plugins/kobc_freight/service.ts +604 -0
- package/src/app/plugins/kobc_freight/types/index.ts +99 -0
- package/src/app/plugins/llm/cache.ts +138 -0
- package/src/app/plugins/llm/chatbot-store.ts +270 -0
- package/src/app/plugins/llm/chunker.ts +96 -0
- package/src/app/plugins/llm/config.example.json +260 -0
- package/src/app/plugins/llm/config.json +71 -0
- package/src/app/plugins/llm/config.ts +99 -0
- package/src/app/plugins/llm/conversation-store.ts +140 -0
- package/src/app/plugins/llm/docs/README.md +120 -0
- package/src/app/plugins/llm/docs/api.md +250 -0
- package/src/app/plugins/llm/document-store.ts +318 -0
- package/src/app/plugins/llm/entities/llm_chatbot.json +66 -0
- package/src/app/plugins/llm/entities/llm_conversation.json +61 -0
- package/src/app/plugins/llm/entities/llm_document.json +67 -0
- package/src/app/plugins/llm/entities/llm_usage.json +51 -0
- package/src/app/plugins/llm/entities/llm_user_profile.json +45 -0
- package/src/app/plugins/llm/handlers.ts +1114 -0
- package/src/app/plugins/llm/index.ts +90 -0
- package/src/app/plugins/llm/profile-store.ts +125 -0
- package/src/app/plugins/llm/providers/anthropic.ts +233 -0
- package/src/app/plugins/llm/providers/azure.ts +267 -0
- package/src/app/plugins/llm/providers/gemini.ts +252 -0
- package/src/app/plugins/llm/providers/index.ts +86 -0
- package/src/app/plugins/llm/providers/ollama.ts +237 -0
- package/src/app/plugins/llm/providers/openai.ts +244 -0
- package/src/app/plugins/llm/routes.ts +73 -0
- package/src/app/plugins/llm/service.ts +965 -0
- package/src/app/plugins/llm/template-loader.ts +135 -0
- package/src/app/plugins/llm/templates/prompts/extract_json.json +8 -0
- package/src/app/plugins/llm/templates/prompts/summarize.json +10 -0
- package/src/app/plugins/llm/templates/prompts/translate.json +10 -0
- package/src/app/plugins/llm/types/chat.ts +96 -0
- package/src/app/plugins/llm/types/chatbot.ts +143 -0
- package/src/app/plugins/llm/types/config.ts +47 -0
- package/src/app/plugins/llm/types/conversation.ts +116 -0
- package/src/app/plugins/llm/types/index.ts +7 -0
- package/src/app/plugins/llm/types/profile.ts +48 -0
- package/src/app/plugins/llm/types/store.ts +50 -0
- package/src/app/plugins/llm/types/usage.ts +27 -0
- package/src/app/plugins/llm/usage-store.ts +64 -0
- package/src/app/plugins/oauth/account/handlers/index.ts +4 -0
- package/src/app/plugins/oauth/account/handlers/link.ts +165 -0
- package/src/app/plugins/oauth/account/handlers/providers-list.ts +49 -0
- package/src/app/plugins/oauth/account/handlers/refresh.ts +92 -0
- package/src/app/plugins/oauth/account/handlers/unlink.ts +105 -0
- package/src/app/plugins/oauth/config.example.json +65 -0
- package/src/app/plugins/oauth/config.json +72 -0
- package/src/app/plugins/oauth/config.ts +182 -0
- package/src/app/plugins/oauth/docs/README.md +160 -0
- package/src/app/plugins/oauth/entities/account_oauth.json +74 -0
- package/src/app/plugins/oauth/handlers/callback.ts +314 -0
- package/src/app/plugins/oauth/handlers/index.ts +2 -0
- package/src/app/plugins/oauth/handlers/redirect.ts +47 -0
- package/src/app/plugins/oauth/index.ts +74 -0
- package/src/app/plugins/oauth/providers/index.ts +530 -0
- package/src/app/plugins/oauth/routes.ts +49 -0
- package/src/app/plugins/oauth/service.ts +14 -0
- package/src/app/plugins/oauth/state.ts +105 -0
- package/src/app/plugins/oauth/types/index.ts +52 -0
- package/src/app/plugins/oauth/upsert.ts +162 -0
- package/src/app/plugins/ocr/cache.ts +50 -0
- package/src/app/plugins/ocr/config.example.json +103 -0
- package/src/app/plugins/ocr/config.json +110 -0
- package/src/app/plugins/ocr/config.ts +126 -0
- package/src/app/plugins/ocr/direction.ts +48 -0
- package/src/app/plugins/ocr/dispatch.ts +130 -0
- package/src/app/plugins/ocr/docs/README.md +125 -0
- package/src/app/plugins/ocr/docs/api.md +159 -0
- package/src/app/plugins/ocr/entities/ocr_result.json +98 -0
- package/src/app/plugins/ocr/entities/ocr_usage.json +57 -0
- package/src/app/plugins/ocr/entity-adapter.ts +198 -0
- package/src/app/plugins/ocr/errors.ts +42 -0
- package/src/app/plugins/ocr/handlers.ts +250 -0
- package/src/app/plugins/ocr/index.ts +68 -0
- package/src/app/plugins/ocr/llm-parser.ts +164 -0
- package/src/app/plugins/ocr/parsing-pipeline.ts +87 -0
- package/src/app/plugins/ocr/pdf-converter.ts +136 -0
- package/src/app/plugins/ocr/preprocessor.ts +313 -0
- package/src/app/plugins/ocr/providers/aws.ts +200 -0
- package/src/app/plugins/ocr/providers/azure.ts +183 -0
- package/src/app/plugins/ocr/providers/google.ts +155 -0
- package/src/app/plugins/ocr/providers/index.ts +80 -0
- package/src/app/plugins/ocr/providers/naver.ts +186 -0
- package/src/app/plugins/ocr/providers/tesseract.ts +198 -0
- package/src/app/plugins/ocr/providers/upstage.ts +156 -0
- package/src/app/plugins/ocr/quota.ts +108 -0
- package/src/app/plugins/ocr/refiner.ts +112 -0
- package/src/app/plugins/ocr/routes.ts +19 -0
- package/src/app/plugins/ocr/service.ts +333 -0
- package/src/app/plugins/ocr/template-loader.ts +72 -0
- package/src/app/plugins/ocr/template-matcher.ts +422 -0
- package/src/app/plugins/ocr/templates/business_reg.json +145 -0
- package/src/app/plugins/ocr/templates/career_cert.json +93 -0
- package/src/app/plugins/ocr/templates/driver_license.json +89 -0
- package/src/app/plugins/ocr/templates/facility_card.json +82 -0
- package/src/app/plugins/ocr/templates/id_card.json +55 -0
- package/src/app/plugins/ocr/templates/invoice.json +92 -0
- package/src/app/plugins/ocr/templates/namecard.json +116 -0
- package/src/app/plugins/ocr/templates/prompts/business_reg.json +14 -0
- package/src/app/plugins/ocr/templates/prompts/career_cert.json +16 -0
- package/src/app/plugins/ocr/templates/prompts/driver_license.json +14 -0
- package/src/app/plugins/ocr/templates/prompts/facility_card.json +15 -0
- package/src/app/plugins/ocr/templates/prompts/general.json +13 -0
- package/src/app/plugins/ocr/templates/prompts/id_card.json +11 -0
- package/src/app/plugins/ocr/templates/prompts/invoice.json +17 -0
- package/src/app/plugins/ocr/templates/prompts/namecard.json +15 -0
- package/src/app/plugins/ocr/templates/prompts/receipt.json +14 -0
- package/src/app/plugins/ocr/templates/receipt.json +79 -0
- package/src/app/plugins/ocr/types/config.ts +60 -0
- package/src/app/plugins/ocr/types/driver.ts +71 -0
- package/src/app/plugins/ocr/types/index.ts +5 -0
- package/src/app/plugins/ocr/types/parsed.ts +101 -0
- package/src/app/plugins/ocr/types/store.ts +70 -0
- package/src/app/plugins/ocr/types/template.ts +89 -0
- package/src/app/plugins/ocr/utils.ts +18 -0
- package/src/app/plugins/pg/config.example.json +79 -0
- package/src/app/plugins/pg/config.json +35 -0
- package/src/app/plugins/pg/config.ts +58 -0
- package/src/app/plugins/pg/docs/README.md +176 -0
- package/src/app/plugins/pg/entities/pg_cancel.json +60 -0
- package/src/app/plugins/pg/entities/pg_order.json +115 -0
- package/src/app/plugins/pg/entities/pg_webhook_log.json +52 -0
- package/src/app/plugins/pg/entity-adapter.ts +144 -0
- package/src/app/plugins/pg/handlers.ts +240 -0
- package/src/app/plugins/pg/index.ts +98 -0
- package/src/app/plugins/pg/providers/danal.ts +178 -0
- package/src/app/plugins/pg/providers/hecto.ts +340 -0
- package/src/app/plugins/pg/providers/index.ts +53 -0
- package/src/app/plugins/pg/providers/inicis.ts +151 -0
- package/src/app/plugins/pg/providers/kakaopay.ts +242 -0
- package/src/app/plugins/pg/providers/kcp.ts +147 -0
- package/src/app/plugins/pg/providers/naverpay.ts +299 -0
- package/src/app/plugins/pg/providers/payco.ts +290 -0
- package/src/app/plugins/pg/providers/payletter.ts +377 -0
- package/src/app/plugins/pg/providers/paypal.ts +423 -0
- package/src/app/plugins/pg/providers/toss.ts +157 -0
- package/src/app/plugins/pg/providers/wanna.ts +163 -0
- package/src/app/plugins/pg/routes.ts +31 -0
- package/src/app/plugins/pg/service.ts +531 -0
- package/src/app/plugins/pg/types/client.ts +52 -0
- package/src/app/plugins/pg/types/config.ts +42 -0
- package/src/app/plugins/pg/types/error.ts +25 -0
- package/src/app/plugins/pg/types/index.ts +4 -0
- package/src/app/plugins/pg/types/payment.ts +145 -0
- package/src/app/plugins/providers/docs/README.md +32 -0
- package/src/app/plugins/providers/solapi-auth.ts +27 -0
- package/src/app/plugins/push/config.example.json +26 -0
- package/src/app/plugins/push/config.json +18 -0
- package/src/app/plugins/push/config.ts +119 -0
- package/src/app/plugins/push/docs/README.md +147 -0
- package/src/app/plugins/push/entities/push_log.json +86 -0
- package/src/app/plugins/push/entities/push_msg.json +56 -0
- package/src/app/plugins/push/entity-adapter.ts +326 -0
- package/src/app/plugins/push/handlers.ts +193 -0
- package/src/app/plugins/push/index.ts +85 -0
- package/src/app/plugins/push/providers/apns.ts +152 -0
- package/src/app/plugins/push/providers/fcm.ts +181 -0
- package/src/app/plugins/push/providers/index.ts +42 -0
- package/src/app/plugins/push/providers/utils.ts +30 -0
- package/src/app/plugins/push/routes.ts +24 -0
- package/src/app/plugins/push/service.ts +297 -0
- package/src/app/plugins/push/types/config.ts +32 -0
- package/src/app/plugins/push/types/index.ts +14 -0
- package/src/app/plugins/push/types/job.ts +79 -0
- package/src/app/plugins/shared/docs/README.md +11 -0
- package/src/app/plugins/sms/config.example.json +30 -0
- package/src/app/plugins/sms/config.json +33 -0
- package/src/app/plugins/sms/config.ts +158 -0
- package/src/app/plugins/sms/docs/README.md +236 -0
- package/src/app/plugins/sms/entities/sms_log.json +65 -0
- package/src/app/plugins/sms/entities/sms_msg.json +82 -0
- package/src/app/plugins/sms/entities/sms_verification.json +50 -0
- package/src/app/plugins/sms/entity-adapter.ts +213 -0
- package/src/app/plugins/sms/handlers.ts +149 -0
- package/src/app/plugins/sms/index.ts +93 -0
- package/src/app/plugins/sms/providers/aligo.ts +73 -0
- package/src/app/plugins/sms/providers/aws-sns.ts +182 -0
- package/src/app/plugins/sms/providers/index.ts +47 -0
- package/src/app/plugins/sms/providers/nhn.ts +82 -0
- package/src/app/plugins/sms/providers/ppurio.ts +76 -0
- package/src/app/plugins/sms/providers/solapi.ts +83 -0
- package/src/app/plugins/sms/routes.ts +23 -0
- package/src/app/plugins/sms/service.ts +239 -0
- package/src/app/plugins/sms/types/client.ts +41 -0
- package/src/app/plugins/sms/types/config.ts +46 -0
- package/src/app/plugins/sms/types/index.ts +3 -0
- package/src/app/plugins/sms/types/job.ts +51 -0
- package/src/app/plugins/sms/verification.ts +162 -0
- package/src/app/plugins/smtp/config.json +5 -0
- package/src/app/plugins/smtp/config.ts +41 -0
- package/src/app/plugins/smtp/docs/README.md +165 -0
- package/src/app/plugins/smtp/handlers.ts +52 -0
- package/src/app/plugins/smtp/index.ts +33 -0
- package/src/app/plugins/smtp/routes.ts +19 -0
- package/src/app/plugins/smtp/templates/layout.html +50 -0
- package/src/app/plugins/smtp/types/config.ts +8 -0
- package/src/app/plugins/smtp/types/index.ts +1 -0
- package/src/app/plugins/taxinvoice/config.example.json +60 -0
- package/src/app/plugins/taxinvoice/config.json +35 -0
- package/src/app/plugins/taxinvoice/config.ts +117 -0
- package/src/app/plugins/taxinvoice/docs/README.md +322 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice.json +229 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice_item.json +56 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice_log.json +50 -0
- package/src/app/plugins/taxinvoice/entities/tax_invoice_party.json +61 -0
- package/src/app/plugins/taxinvoice/entity-adapter.ts +285 -0
- package/src/app/plugins/taxinvoice/handlers.ts +120 -0
- package/src/app/plugins/taxinvoice/index.ts +74 -0
- package/src/app/plugins/taxinvoice/providers/barobill.ts +273 -0
- package/src/app/plugins/taxinvoice/providers/bolta.ts +193 -0
- package/src/app/plugins/taxinvoice/providers/esero.ts +201 -0
- package/src/app/plugins/taxinvoice/providers/index.ts +41 -0
- package/src/app/plugins/taxinvoice/providers/popbill.ts +258 -0
- package/src/app/plugins/taxinvoice/providers/sendbill.ts +443 -0
- package/src/app/plugins/taxinvoice/providers/smartbill.ts +234 -0
- package/src/app/plugins/taxinvoice/routes.ts +17 -0
- package/src/app/plugins/taxinvoice/service.ts +439 -0
- package/src/app/plugins/taxinvoice/types/client.ts +57 -0
- package/src/app/plugins/taxinvoice/types/config.ts +42 -0
- package/src/app/plugins/taxinvoice/types/index.ts +4 -0
- package/src/app/plugins/taxinvoice/types/invoice.ts +128 -0
- package/src/app/plugins/taxinvoice/types/queue.ts +22 -0
- package/src/app/plugins/vessel_kr/config.json +9 -0
- package/src/app/plugins/vessel_kr/config.ts +32 -0
- package/src/app/plugins/vessel_kr/docs/README.md +167 -0
- package/src/app/plugins/vessel_kr/entities/vessel_kr_entry.json +136 -0
- package/src/app/plugins/vessel_kr/handlers.ts +102 -0
- package/src/app/plugins/vessel_kr/index.ts +21 -0
- package/src/app/plugins/vessel_kr/routes.ts +15 -0
- package/src/app/plugins/vessel_kr/service.ts +264 -0
- package/src/app/plugins/vessel_kr/types/index.ts +100 -0
- package/src/app/routes/README.md +71 -0
- package/src/app/routes/account/change-password/config.json +5 -0
- package/src/app/routes/account/change-password/entities/password_history.json +18 -0
- package/src/app/routes/account/change-password/handlers.ts +204 -0
- package/src/app/routes/account/change-password/routes.ts +28 -0
- package/src/app/routes/account/config.json +5 -0
- package/src/app/routes/account/reactivate/config.json +5 -0
- package/src/app/routes/account/reactivate/handlers.ts +249 -0
- package/src/app/routes/account/reactivate/routes.ts +14 -0
- package/src/app/routes/account/register/config-loader.ts +34 -0
- package/src/app/routes/account/register/config.json +8 -0
- package/src/app/routes/account/register/handlers.ts +207 -0
- package/src/app/routes/account/register/routes.ts +25 -0
- package/src/app/routes/account/register/types/index.ts +50 -0
- package/src/app/routes/account/routes.ts +31 -0
- package/src/app/routes/account/templates/force_reset.html +18 -0
- package/src/app/routes/account/templates/welcome.html +14 -0
- package/src/app/routes/account/withdraw/handlers.ts +111 -0
- package/src/app/routes/account/withdraw/routes.ts +18 -0
- package/src/app/routes/approval/config.json +5 -0
- package/src/app/routes/approval/entities/approval.json +99 -0
- package/src/app/routes/approval/entities/comments.json +17 -0
- package/src/app/routes/approval/entities/reference.json +16 -0
- package/src/app/routes/approval/routes.ts +30 -0
- package/src/app/routes/auth/config.json +5 -0
- package/src/app/routes/auth/handlers.ts +245 -0
- package/src/app/routes/auth/routes.ts +16 -0
- package/src/app/routes/board/config.json +5 -0
- package/src/app/routes/board/entities/board_category.json +90 -0
- package/src/app/routes/board/entities/board_comment.json +83 -0
- package/src/app/routes/board/entities/board_like.json +51 -0
- package/src/app/routes/board/entities/board_mention.json +50 -0
- package/src/app/routes/board/entities/board_post.json +148 -0
- package/src/app/routes/board/entities/board_post_tag.json +41 -0
- package/src/app/routes/board/entities/board_rating.json +127 -0
- package/src/app/routes/board/entities/board_read_log.json +29 -0
- package/src/app/routes/board/entities/board_report.json +53 -0
- package/src/app/routes/board/entities/board_tag.json +21 -0
- package/src/app/routes/board/handlers/categories.ts +134 -0
- package/src/app/routes/board/handlers/comments.ts +207 -0
- package/src/app/routes/board/handlers/files.ts +104 -0
- package/src/app/routes/board/handlers/likes.ts +31 -0
- package/src/app/routes/board/handlers/mentions.ts +54 -0
- package/src/app/routes/board/handlers/posts.ts +577 -0
- package/src/app/routes/board/handlers/ratings.ts +60 -0
- package/src/app/routes/board/handlers/reports.ts +131 -0
- package/src/app/routes/board/handlers/tags.ts +81 -0
- package/src/app/routes/board/routes.ts +137 -0
- package/src/app/routes/calendar/config.json +5 -0
- package/src/app/routes/calendar/entities/calendar_attendees.json +23 -0
- package/src/app/routes/calendar/entities/calendar_comments.json +17 -0
- package/src/app/routes/calendar/entities/calendar_events.json +48 -0
- package/src/app/routes/calendar/entities/calendar_kind.json +11 -0
- package/src/app/routes/calendar/entities/calendar_method.json +11 -0
- package/src/app/routes/calendar/routes.ts +32 -0
- package/src/app/routes/email-verify/config-loader.ts +47 -0
- package/src/app/routes/email-verify/config.example.json +13 -0
- package/src/app/routes/email-verify/config.json +16 -0
- package/src/app/routes/email-verify/entities/account.json +23 -0
- package/src/app/routes/email-verify/handlers/activate.ts +103 -0
- package/src/app/routes/email-verify/handlers/change.ts +106 -0
- package/src/app/routes/email-verify/handlers/confirm.ts +87 -0
- package/src/app/routes/email-verify/handlers/index.ts +20 -0
- package/src/app/routes/email-verify/handlers/send.ts +157 -0
- package/src/app/routes/email-verify/handlers/status.ts +53 -0
- package/src/app/routes/email-verify/handlers/utils.ts +85 -0
- package/src/app/routes/email-verify/routes.ts +54 -0
- package/src/app/routes/email-verify/templates/verification.html +15 -0
- package/src/app/routes/email-verify/templates/verification_link.html +19 -0
- package/src/app/routes/email-verify/types/index.ts +77 -0
- package/src/app/routes/email-verify/verification-utils.ts +57 -0
- package/src/app/routes/example-db/config.json +5 -0
- package/src/app/routes/example-db/handlers.ts +220 -0
- package/src/app/routes/example-db/models/account-ext.ts +33 -0
- package/src/app/routes/example-db/models/users.ts +30 -0
- package/src/app/routes/example-db/routes.ts +23 -0
- package/src/app/routes/example-db/types/defaults.ts +21 -0
- package/src/app/routes/example-db/types/index.ts +4 -0
- package/src/app/routes/example-db/types/params.ts +3 -0
- package/src/app/routes/example-db/types/query.ts +6 -0
- package/src/app/routes/example-db/types/user.ts +11 -0
- package/src/app/routes/example-es/config.json +5 -0
- package/src/app/routes/example-es/handlers.ts +216 -0
- package/src/app/routes/example-es/routes.ts +24 -0
- package/src/app/routes/example-es/types/defaults.ts +30 -0
- package/src/app/routes/example-es/types/index.ts +4 -0
- package/src/app/routes/example-es/types/params.ts +3 -0
- package/src/app/routes/example-es/types/post.ts +12 -0
- package/src/app/routes/example-es/types/query.ts +14 -0
- package/src/app/routes/funeral/config.json +5 -0
- package/src/app/routes/funeral/entities/funeral.json +77 -0
- package/src/app/routes/funeral/entities/funeral_docs.json +36 -0
- package/src/app/routes/funeral/entities/funeral_mourner.json +31 -0
- package/src/app/routes/funeral/entities/funeral_order.json +48 -0
- package/src/app/routes/funeral/entities/funeral_room.json +61 -0
- package/src/app/routes/funeral/entities/funeral_schedule.json +39 -0
- package/src/app/routes/funeral/routes.ts +32 -0
- package/src/app/routes/health/config.json +5 -0
- package/src/app/routes/health/handlers.ts +69 -0
- package/src/app/routes/health/routes.ts +14 -0
- package/src/app/routes/hr/career/config.json +5 -0
- package/src/app/routes/hr/career/entities/employee_career.json +15 -0
- package/src/app/routes/hr/career/routes.ts +25 -0
- package/src/app/routes/hr/config.json +5 -0
- package/src/app/routes/hr/education/config.json +5 -0
- package/src/app/routes/hr/education/entities/employee_education.json +29 -0
- package/src/app/routes/hr/education/entities/employee_education_mans.json +25 -0
- package/src/app/routes/hr/education/entities/employee_school.json +19 -0
- package/src/app/routes/hr/education/routes.ts +28 -0
- package/src/app/routes/hr/employee/config.json +5 -0
- package/src/app/routes/hr/employee/entities/employee.json +59 -0
- package/src/app/routes/hr/employee/entities/employee_cert.json +19 -0
- package/src/app/routes/hr/employee/entities/employee_reward.json +21 -0
- package/src/app/routes/hr/employee/routes.ts +27 -0
- package/src/app/routes/hr/entities/hr_group.json +47 -0
- package/src/app/routes/hr/entities/hr_group_pv.json +20 -0
- package/src/app/routes/hr/entities/hr_role.json +43 -0
- package/src/app/routes/hr/entities/hr_role_pv.json +20 -0
- package/src/app/routes/hr/routes.ts +29 -0
- package/src/app/routes/messages/chat/config.json +5 -0
- package/src/app/routes/messages/chat/entities/user_chat.json +47 -0
- package/src/app/routes/messages/chat/entities/user_chat_room.json +38 -0
- package/src/app/routes/messages/chat/entities/user_chat_room_member.json +49 -0
- package/src/app/routes/messages/chat/routes.ts +28 -0
- package/src/app/routes/messages/msgbox/config.json +5 -0
- package/src/app/routes/messages/msgbox/entities/user_msgbox.json +73 -0
- package/src/app/routes/messages/msgbox/routes.ts +28 -0
- package/src/app/routes/password-reset/config.example.json +13 -0
- package/src/app/routes/password-reset/config.json +15 -0
- package/src/app/routes/password-reset/entities/account.json +13 -0
- package/src/app/routes/password-reset/handlers.ts +335 -0
- package/src/app/routes/password-reset/password-utils.ts +96 -0
- package/src/app/routes/password-reset/routes.ts +84 -0
- package/src/app/routes/password-reset/templates/password_reset.html +21 -0
- package/src/app/routes/password-reset/templates/password_reset_link.html +19 -0
- package/src/app/routes/password-reset/types/index.ts +95 -0
- package/src/app/routes/privilege/config.json +5 -0
- package/src/app/routes/privilege/entities/pv_group.json +29 -0
- package/src/app/routes/privilege/entities/pv_group_item.json +31 -0
- package/src/app/routes/privilege/entities/pv_item.json +176 -0
- package/src/app/routes/privilege/entities/user_pv_group.json +20 -0
- package/src/app/routes/privilege/entities/user_pv_item.json +20 -0
- package/src/app/routes/privilege/routes.ts +33 -0
- package/src/app/routes/user/config.json +5 -0
- package/src/app/routes/user/entities/user.json +64 -0
- package/src/app/routes/user/entities/user_biometric.json +28 -0
- package/src/app/routes/user/routes.ts +27 -0
- package/src/app/routes/vessel-tracking/config.json +3 -0
- package/src/app/routes/vessel-tracking/entities/tracked_vessel.json +261 -0
- package/src/app/routes/vessel-tracking/handlers.ts +134 -0
- package/src/app/routes/vessel-tracking/routes.ts +25 -0
- package/src/app/routes/vessel-tracking/types/index.ts +5 -0
- package/src/app/routes/vessel-tracking/types/vessel.ts +59 -0
- package/src/app/schedules/README.md +105 -0
- package/src/app/schedules/ais_sync/config.json +4 -0
- package/src/app/schedules/ais_sync/index.ts +69 -0
- package/src/app/schedules/data-retention/config.json +9 -0
- package/src/app/schedules/data-retention/index.ts +238 -0
- package/src/app/schedules/dormancy/config.json +15 -0
- package/src/app/schedules/dormancy/entities/account.json +14 -0
- package/src/app/schedules/dormancy/entities/privacy_cron_lock.json +23 -0
- package/src/app/schedules/dormancy/index.ts +289 -0
- package/src/app/schedules/dormancy/templates/dormancy_completed.html +21 -0
- package/src/app/schedules/dormancy/templates/dormancy_warning.html +20 -0
- package/src/app/schedules/kobc_freight_sync/config.json +4 -0
- package/src/app/schedules/kobc_freight_sync/index.ts +94 -0
- package/src/app/schedules/vessel_kr_sync/config.json +4 -0
- package/src/app/schedules/vessel_kr_sync/index.ts +72 -0
- package/src/system/app.ts +129 -0
- package/src/system/cache/_store-ref.ts +15 -0
- package/src/system/cache/config.ts +61 -0
- package/src/system/cache/drivers/memcached.ts +135 -0
- package/src/system/cache/drivers/memory.ts +92 -0
- package/src/system/cache/drivers/redis.ts +109 -0
- package/src/system/cache/index.ts +43 -0
- package/src/system/cache/namespaced.ts +79 -0
- package/src/system/cache/plugin.ts +59 -0
- package/src/system/cache/types.ts +81 -0
- package/src/system/config/config-path.ts +20 -0
- package/src/system/config/cors.ts +49 -0
- package/src/system/config/database.ts +190 -0
- package/src/system/config/entity-server.ts +8 -0
- package/src/system/config/env-substitution.ts +4 -0
- package/src/system/config/env.ts +30 -0
- package/src/system/config/json-config.ts +13 -0
- package/src/system/config/module-path.ts +16 -0
- package/src/system/config/packet-encrypt.ts +80 -0
- package/src/system/config/rate-limit.ts +4 -0
- package/src/system/config/security-loader.ts +25 -0
- package/src/system/config/security.ts +16 -0
- package/src/system/config/server.ts +81 -0
- package/src/system/crypto/cipher.ts +117 -0
- package/src/system/crypto/data-encrypt.ts +174 -0
- package/src/system/crypto/hash.ts +24 -0
- package/src/system/crypto/packet.test.ts +23 -0
- package/src/system/crypto/packet.ts +97 -0
- package/src/system/crypto/random.ts +19 -0
- package/src/system/email/sender.ts +85 -0
- package/src/system/email/template-engine.ts +147 -0
- package/src/system/entity-server/bootstrap.ts +270 -0
- package/src/system/entity-server/client.ts +64 -0
- package/src/system/hooks/loader.ts +32 -0
- package/src/system/hooks/runner.ts +159 -0
- package/src/system/hooks/types.ts +75 -0
- package/src/system/hooks/withdraw-hooks.ts +42 -0
- package/src/system/http/cookie.ts +62 -0
- package/src/system/http/response.ts +16 -0
- package/src/system/index.ts +48 -0
- package/src/system/logging/log-format.ts +50 -0
- package/src/system/logging/logger.ts +104 -0
- package/src/system/middleware/_db-ref.ts +26 -0
- package/src/system/middleware/_push-ref.ts +28 -0
- package/src/system/middleware/access-log.ts +34 -0
- package/src/system/middleware/auth.ts +67 -0
- package/src/system/middleware/csrf.ts +172 -0
- package/src/system/middleware/database.ts +44 -0
- package/src/system/middleware/error-handler.ts +51 -0
- package/src/system/middleware/extension-loader.ts +111 -0
- package/src/system/middleware/packet-encrypt.ts +281 -0
- package/src/system/middleware/request-id.ts +18 -0
- package/src/system/plugins/access-log.ts +34 -0
- package/src/system/plugins/packet-encrypt.ts +281 -0
- package/src/system/proxy/register.ts +37 -0
- package/src/system/public-api.ts +140 -0
- package/src/system/push/sender.ts +131 -0
- package/src/system/routes/entity-interceptor.ts +327 -0
- package/src/system/routes/loader.ts +215 -0
- package/src/system/scheduler/cron-utils.ts +150 -0
- package/src/system/scheduler/distributed-lock.ts +141 -0
- package/src/system/scheduler/schedule-loader.ts +105 -0
- package/src/system/security/anonymous-device-id.ts +41 -0
- package/src/system/security/anonymous-device.ts +98 -0
- package/src/system/security/anonymous-packet-token.ts +23 -0
- package/src/system/security/packet-bootstrap.ts +16 -0
- package/src/system/security/password-policy.ts +191 -0
- package/src/system/startup-banner.ts +191 -0
- package/src/system/types/fastify.d.ts +53 -0
- package/src/system/utils/app-path.ts +31 -0
- package/src/system/utils/coerce.ts +28 -0
- package/src/system/utils/date-prefixed-log-stream.ts +176 -0
- package/src/system/utils/errors.ts +66 -0
- package/src/system/utils/format.ts +45 -0
- package/src/system/utils/http-client.ts +79 -0
- package/src/system/utils/user-agent.ts +82 -0
- package/tsconfig.app.json +17 -0
- package/tsconfig.json +39 -0
package/docs/README.md
ADDED
|
@@ -0,0 +1,274 @@
|
|
|
1
|
+
# 커스터마이징 가이드
|
|
2
|
+
|
|
3
|
+
Entity Server Gateway는 `app/` 폴더의 TypeScript 소스를 직접 수정해 동작을 확장할 수 있습니다.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 폴더 구조
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
app/
|
|
11
|
+
plugins/ — 비즈니스 플러그인 (결제·LLM·알림 등)
|
|
12
|
+
alimtalk/ — 카카오 알림톡
|
|
13
|
+
friendtalk/ — 카카오 친구톡
|
|
14
|
+
holidays/ — 공휴일 자동 동기화
|
|
15
|
+
identity/ — 본인인증 (NICE, KMC, Danal)
|
|
16
|
+
llm/ — LLM 연동 (OpenAI, Gemini, Claude 등)
|
|
17
|
+
ocr/ — OCR 문서 인식
|
|
18
|
+
pg/ — 결제 (토스, KCP, 이니시스, 페이레터 등)
|
|
19
|
+
taxinvoice/ — 전자세금계산서
|
|
20
|
+
routes/ — 커스텀 API 엔드포인트
|
|
21
|
+
health/ — 헬스체크 (기본 제공)
|
|
22
|
+
schedules/ — 백그라운드 크론 스케줄
|
|
23
|
+
dormancy/ — 장기 미접속 계정 휴면 전환
|
|
24
|
+
data-retention/ — 개인정보 보유 기간 만료 삭제
|
|
25
|
+
hooks/
|
|
26
|
+
registry.ts — 엔티티 이벤트 훅 등록
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## 플러그인 수정
|
|
32
|
+
|
|
33
|
+
각 플러그인은 `app/plugins/{name}/index.ts`의 Fastify 플러그인으로 구성됩니다.
|
|
34
|
+
서버 시작 시 `plugins/` 하위 폴더를 알파벳 순으로 자동 탐색해 등록합니다.
|
|
35
|
+
|
|
36
|
+
**기존 모듈 핸들러 수정 예시:**
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
// app/plugins/llm/handlers.ts
|
|
40
|
+
import { ok, fail } from "@gateway/api";
|
|
41
|
+
|
|
42
|
+
export async function chatHandler(req, reply) {
|
|
43
|
+
// 원하는 로직으로 수정
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
**새 플러그인 추가:**
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
app/plugins/my-module/
|
|
51
|
+
index.ts — Fastify 플러그인 (default export 필수)
|
|
52
|
+
handlers.ts
|
|
53
|
+
routes.ts
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
// app/plugins/my-module/index.ts
|
|
58
|
+
import type { FastifyInstance } from "fastify";
|
|
59
|
+
|
|
60
|
+
export default async function myModulePlugin(app: FastifyInstance) {
|
|
61
|
+
app.get("/my-module/hello", async (req, reply) => {
|
|
62
|
+
return { message: "hello" };
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
서버를 재시작하면 자동으로 로드됩니다.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## 커스텀 라우트 추가
|
|
72
|
+
|
|
73
|
+
`app/routes/{name}/index.ts`에 Fastify 플러그인을 작성합니다.
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
// app/routes/orders/index.ts
|
|
77
|
+
import type { FastifyInstance } from "fastify";
|
|
78
|
+
import { ok } from "@gateway/api";
|
|
79
|
+
|
|
80
|
+
export default async function ordersRoutes(app: FastifyInstance) {
|
|
81
|
+
app.get("/orders", async (req, reply) => {
|
|
82
|
+
return reply.send(ok([{ id: 1 }]));
|
|
83
|
+
});
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 스케줄 추가
|
|
90
|
+
|
|
91
|
+
`app/schedules/{name}/index.ts`에 `start()` / `stop()`을 구현합니다.
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
// app/schedules/subscription-reminder/index.ts
|
|
95
|
+
import { createCron, logger, type CronHandle } from "@gateway/api";
|
|
96
|
+
|
|
97
|
+
let cronHandle: CronHandle | null = null;
|
|
98
|
+
|
|
99
|
+
export function start(): void {
|
|
100
|
+
cronHandle = createCron({
|
|
101
|
+
expression: "0 9 * * 1", // 매주 월요일 09:00
|
|
102
|
+
onTick: async () => {
|
|
103
|
+
// 배치 로직
|
|
104
|
+
},
|
|
105
|
+
});
|
|
106
|
+
logger.info("subscription-reminder scheduler started");
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function stop(): void {
|
|
110
|
+
cronHandle?.stop();
|
|
111
|
+
cronHandle = null;
|
|
112
|
+
}
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
서버를 재시작하면 자동으로 로드됩니다.
|
|
116
|
+
자세한 내용은 [스케줄 추가 가이드](schedules/how-to-create.md)를 참고하세요.
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## 엔티티 훅
|
|
121
|
+
|
|
122
|
+
엔티티 CRUD 이벤트(before/after) 전후에 커스텀 로직을 실행합니다.
|
|
123
|
+
Get 훅은 조회 접근 제어/응답 가공(find 조회에도 afterGet 자동 적용), Submit 훅은 `SubmitContext`를 받아 **수정 전(old) / 요청(new)** 데이터에 모두 접근할 수 있습니다.
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
// app/hooks/entities/order.ts
|
|
127
|
+
import type {
|
|
128
|
+
EntityHook,
|
|
129
|
+
SubmitContext,
|
|
130
|
+
DeleteContext,
|
|
131
|
+
UserInfo,
|
|
132
|
+
} from "@gateway/api";
|
|
133
|
+
import { logger, ValidationError, ForbiddenError } from "@gateway/api";
|
|
134
|
+
|
|
135
|
+
export const orderHook: EntityHook = {
|
|
136
|
+
async afterGet(entity, data: any, user: UserInfo) {
|
|
137
|
+
// 관리자가 아니면 전화번호 마스킹
|
|
138
|
+
if (user.role !== "admin" && data.phone) {
|
|
139
|
+
data.phone = data.phone.replace(/(\d{3})\d{4}(\d{4})/, "$1****$2");
|
|
140
|
+
}
|
|
141
|
+
return data;
|
|
142
|
+
},
|
|
143
|
+
async beforeSubmit(entity, ctx: SubmitContext, user: UserInfo) {
|
|
144
|
+
// ctx.old — 수정 전 데이터 (신규 INSERT 시 null)
|
|
145
|
+
// ctx.new — 클라이언트 요청 데이터
|
|
146
|
+
if (!ctx.old && (!ctx.new.items || ctx.new.items.length === 0)) {
|
|
147
|
+
throw new ValidationError("주문 항목이 비어있습니다");
|
|
148
|
+
}
|
|
149
|
+
return { ...ctx.new, ordered_by: user.sub };
|
|
150
|
+
},
|
|
151
|
+
async afterSubmit(entity, ctx: SubmitContext, user: UserInfo) {
|
|
152
|
+
// ctx.old / ctx.new 로 변경 전후 비교 가능
|
|
153
|
+
if (ctx.old && ctx.old.status !== ctx.new.status) {
|
|
154
|
+
logger.info(
|
|
155
|
+
{ from: ctx.old.status, to: ctx.new.status },
|
|
156
|
+
"상태 변경",
|
|
157
|
+
);
|
|
158
|
+
}
|
|
159
|
+
return ctx.new;
|
|
160
|
+
},
|
|
161
|
+
async beforeDelete(entity, ctx: DeleteContext, user: UserInfo) {
|
|
162
|
+
// ctx.data — 삭제 대상 데이터 (조회 실패 시 null)
|
|
163
|
+
if (ctx.data?.status === "completed") {
|
|
164
|
+
throw new ForbiddenError("완료된 주문은 삭제할 수 없습니다");
|
|
165
|
+
}
|
|
166
|
+
logger.info(
|
|
167
|
+
{ seq: ctx.seq, orderNo: ctx.data?.order_no },
|
|
168
|
+
"주문 삭제 요청",
|
|
169
|
+
);
|
|
170
|
+
return true;
|
|
171
|
+
},
|
|
172
|
+
async afterDelete(entity, ctx: DeleteContext, user: UserInfo) {
|
|
173
|
+
logger.info(
|
|
174
|
+
{ seq: ctx.seq, orderNo: ctx.data?.order_no },
|
|
175
|
+
"주문 삭제 완료",
|
|
176
|
+
);
|
|
177
|
+
},
|
|
178
|
+
};
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
```ts
|
|
182
|
+
// app/hooks/registry.ts
|
|
183
|
+
import type { EntityHook } from "@gateway/api";
|
|
184
|
+
import { orderHook } from "./entities/order.ts";
|
|
185
|
+
|
|
186
|
+
export const hookRegistry: Record<string, EntityHook> = {
|
|
187
|
+
order: orderHook,
|
|
188
|
+
};
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
## 공개 API (`@gateway/api`)
|
|
194
|
+
|
|
195
|
+
app 코드에서 사용할 수 있는 헬퍼:
|
|
196
|
+
|
|
197
|
+
```ts
|
|
198
|
+
import { ok, fail, logger, entityServer } from "@gateway/api";
|
|
199
|
+
import { cache, dbConn } from "@gateway/api";
|
|
200
|
+
import { NotFoundError, BadRequestError } from "@gateway/api";
|
|
201
|
+
import type {
|
|
202
|
+
EntityHook,
|
|
203
|
+
SubmitContext,
|
|
204
|
+
DeleteContext,
|
|
205
|
+
UserInfo,
|
|
206
|
+
CacheStore,
|
|
207
|
+
CacheDriver,
|
|
208
|
+
} from "@gateway/api";
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
| export | 설명 |
|
|
212
|
+
| ------------------------- | ----------------------------------------------- |
|
|
213
|
+
| `ok(data, requestId?)` | 성공 응답 객체 생성 |
|
|
214
|
+
| `fail(error, requestId?)` | 실패 응답 객체 생성 |
|
|
215
|
+
| `logger` | pino 로거 인스턴스 |
|
|
216
|
+
| `entityServer` | Entity Server REST 클라이언트 |
|
|
217
|
+
| `cache()` | 캐시 스토어 반환 — [캐시 가이드](cache.md) 참고 |
|
|
218
|
+
| `dbConn(group?)` | Kysely DB 인스턴스 반환 |
|
|
219
|
+
| `AppError` | 커스텀 에러 베이스 클래스 |
|
|
220
|
+
| `BadRequestError` | 400 에러 |
|
|
221
|
+
| `UnauthorizedError` | 401 에러 |
|
|
222
|
+
| `ForbiddenError` | 403 에러 |
|
|
223
|
+
| `NotFoundError` | 404 에러 |
|
|
224
|
+
| `ConflictError` | 409 에러 |
|
|
225
|
+
| `ValidationError` | 422 에러 |
|
|
226
|
+
| `CacheStore` | 캐시 스토어 인터페이스 (type) |
|
|
227
|
+
| `CacheDriver` | `"memory" \| "redis" \| "memcached"` (type) |
|
|
228
|
+
| `EntityHook` | 훅 인터페이스 (type) |
|
|
229
|
+
| `SubmitContext` | submit 훅 old/new 컨텍스트 (type) |
|
|
230
|
+
| `DeleteContext` | delete 훅 seq/data 컨텍스트 (type) |
|
|
231
|
+
| `UserInfo` | JWT에서 디코딩된 사용자 정보 (type) |
|
|
232
|
+
|
|
233
|
+
---
|
|
234
|
+
|
|
235
|
+
## 설정 파일
|
|
236
|
+
|
|
237
|
+
`configs/` 폴더의 JSON 파일로 서버 동작을 설정합니다.
|
|
238
|
+
전체 항목은 [설정 파일 가이드](configs.md)를 참고하세요.
|
|
239
|
+
|
|
240
|
+
```
|
|
241
|
+
configs/
|
|
242
|
+
server.json — 포트, 호스트, 로깅
|
|
243
|
+
database.json — DB 연결
|
|
244
|
+
cors.json — CORS 설정
|
|
245
|
+
security.json — CSRF, 패킷 암호화
|
|
246
|
+
cache.json — 캐시 드라이버 (memory / redis / memcached)
|
|
247
|
+
|
|
248
|
+
app/plugins/ — 각 플러그인 디렉토리에 설정 파일 포함
|
|
249
|
+
alimtalk/config.json — 카카오 알림톡
|
|
250
|
+
friendtalk/config.json — 카카오 친구톡
|
|
251
|
+
holidays/config.json — 공휴일 동기화
|
|
252
|
+
identity/config.json — 본인인증
|
|
253
|
+
llm/config.json — LLM API 키
|
|
254
|
+
ocr/config.json — OCR 설정
|
|
255
|
+
pg/config.json — 결제 PG 설정
|
|
256
|
+
push/config.json — FCM/APNs 푸시 알림
|
|
257
|
+
sms/config.json — SMS 발송 설정
|
|
258
|
+
taxinvoice/config.json — 전자세금계산서
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
---
|
|
262
|
+
|
|
263
|
+
## 관련 문서
|
|
264
|
+
|
|
265
|
+
- [아키텍처](architecture.md) — 전체 구조, Gateway 4가지 역할, 인증 흐름
|
|
266
|
+
- [system/ 내부 구조](system.md) — 서버 코어 디렉터리 구조와 각 모듈 역할
|
|
267
|
+
- [내부 구조](internals.md) — 부트스트랩 순서, 요청 처리 흐름
|
|
268
|
+
- [설정 파일](configs.md) — .env, server.json, database.json 등
|
|
269
|
+
- [보안 설정](security.md) — CORS, CSRF, 패킷 암호화, 비밀번호 정책
|
|
270
|
+
- [캐시](cache.md) — memory/Redis/Memcached 캐시 사용법
|
|
271
|
+
- [훅](hooks.md) — 엔티티 CRUD 훅 상세 가이드
|
|
272
|
+
- [플러그인 추가](plugins/how-to-create.md) — 새 플러그인 작성 가이드
|
|
273
|
+
- [라우트 추가](routes/how-to-create.md) — 새 라우트 작성 가이드
|
|
274
|
+
- [스크립트 가이드](scripts-guide.md) — run/build/push/release 스크립트 사용법
|
|
@@ -0,0 +1,295 @@
|
|
|
1
|
+
# 아키텍처
|
|
2
|
+
|
|
3
|
+
Entity Server Gateway의 전체 구조와 각 계층의 역할을 설명합니다.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 전체 구조
|
|
8
|
+
|
|
9
|
+
```mermaid
|
|
10
|
+
graph TD
|
|
11
|
+
FE["Frontend<br/>(React)"] -- "HTTPS" --> GW
|
|
12
|
+
|
|
13
|
+
subgraph GW["Gateway Server"]
|
|
14
|
+
direction LR
|
|
15
|
+
SYS["system.js<br/>서버 코어"]
|
|
16
|
+
API["system-api.js<br/>공개 API"]
|
|
17
|
+
APP["app/<br/>plugins · routes · hooks"]
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
GW -- "HTTP 프록시" --> ES["Entity Server"]
|
|
21
|
+
GW -- "app.db 직접 쿼리" --> DB1[("DB<br/>일반·idx 테이블")]
|
|
22
|
+
ES --> DB2[("DB<br/>엔티티 CRUD·인증·파일")]
|
|
23
|
+
|
|
24
|
+
DB1 -. "같은 DB일 수도 <br>다른 DB일 수도" .- DB2
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
- **Frontend**는 Gateway Server 하나만 인식합니다.
|
|
28
|
+
- **Gateway**가 요청 종류에 따라 Entity Server로 **프록시**하거나 **자체 비즈니스 로직**으로 처리합니다.
|
|
29
|
+
- **DB**는 두 경로로 접근됩니다:
|
|
30
|
+
- **Entity Server** — 엔티티 CRUD, 인증, 파일 등 표준 기능
|
|
31
|
+
- **Gateway Server** — 직접 접속 (`app.db`)으로 일반 테이블, idx 테이블, 집계 쿼리 등
|
|
32
|
+
- 두 서버가 **같은 DB**를 공유할 수도, **각각 별도 DB**를 사용할 수도 있습니다.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Gateway의 4가지 역할
|
|
37
|
+
|
|
38
|
+
### 1. 플러그인 제공
|
|
39
|
+
|
|
40
|
+
외부 API(LLM, OCR, 결제, 알림톡 등)를 통합하는 비즈니스 플러그인입니다.
|
|
41
|
+
|
|
42
|
+
```mermaid
|
|
43
|
+
graph LR
|
|
44
|
+
EXT["app/plugins/"]
|
|
45
|
+
EXT --> tfa["2fa/<br/>2단계 인증 (TOTP)"]
|
|
46
|
+
EXT --> ali["alimtalk/<br/>카카오 알림톡"]
|
|
47
|
+
EXT --> fri["friendtalk/<br/>카카오 친구톡"]
|
|
48
|
+
EXT --> hol["holidays/<br/>공휴일 조회"]
|
|
49
|
+
EXT --> idn["identity/<br/>본인인증"]
|
|
50
|
+
EXT --> llm["llm/<br/>LLM 연동 (OpenAI · Gemini · Claude)"]
|
|
51
|
+
EXT --> oau["oauth/<br/>소셜 로그인"]
|
|
52
|
+
EXT --> ocr["ocr/<br/>문서 OCR 인식"]
|
|
53
|
+
EXT --> pg["pg/<br/>결제 (토스 · KG이니시스 · 나이스)"]
|
|
54
|
+
EXT --> psh["push/<br/>푸시 알림"]
|
|
55
|
+
EXT --> sms["sms/<br/>SMS 발송"]
|
|
56
|
+
EXT --> tax["taxinvoice/<br/>전자세금계산서"]
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
`app/plugins/{name}/index.ts`에 Fastify 플러그인을 작성하면 서버 시작 시 자동 로드됩니다.
|
|
60
|
+
각 플러그인은 자신이 사용하는 템플릿을 `plugins/{name}/templates/` 아래에 직접 보유합니다.
|
|
61
|
+
|
|
62
|
+
### 2. 비즈니스 로직 라우트
|
|
63
|
+
|
|
64
|
+
Entity Server가 제공하지 않는 커스텀 API를 추가합니다.
|
|
65
|
+
예: 대시보드 집계, 복합 조회, 외부 연동, 리포트 생성 등.
|
|
66
|
+
|
|
67
|
+
```mermaid
|
|
68
|
+
graph LR
|
|
69
|
+
RT["app/routes/"]
|
|
70
|
+
RT --> h["health/<br/>헬스체크 (기본 제공)"]
|
|
71
|
+
RT --> ac["account/<br/>회원가입 · 탈퇴 · 비밀번호 변경"]
|
|
72
|
+
RT --> ev["email-verify/<br/>이메일 인증"]
|
|
73
|
+
RT --> pr["password-reset/<br/>비밀번호 재설정"]
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
각 라우트는 자신이 사용하는 이메일 템플릿을 `routes/{name}/templates/` 아래에 직접 보유합니다.
|
|
77
|
+
|
|
78
|
+
### 3. DB 직접 접속
|
|
79
|
+
|
|
80
|
+
Entity Server를 거치지 않고 DB에 직접 쿼리합니다.
|
|
81
|
+
엔티티 테이블 외 일반 테이블이나 `idx_*` 인덱스 테이블 조회 등에 사용합니다.
|
|
82
|
+
|
|
83
|
+
```ts
|
|
84
|
+
// app.db 를 통한 직접 쿼리
|
|
85
|
+
const rows = await app.db.query(
|
|
86
|
+
"SELECT * FROM dashboard_stats WHERE ...",
|
|
87
|
+
params,
|
|
88
|
+
);
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
`configs/database.json`으로 설정하며, 미설정 시 `app.db = null`로 비활성화됩니다.
|
|
92
|
+
|
|
93
|
+
### 4. 요청 라우팅
|
|
94
|
+
|
|
95
|
+
Entity Server는 내부망에서만 접근 가능하고, Frontend는 Gateway만 인식합니다.
|
|
96
|
+
|
|
97
|
+
```mermaid
|
|
98
|
+
flowchart LR
|
|
99
|
+
FE[Frontend] -- "/api/v1/*" --> GW[Gateway]
|
|
100
|
+
|
|
101
|
+
GW -- "프록시" --> ES["Entity Server<br/>auth · oauth · entity · files<br/>push · smtp · sms · identity · utils"]
|
|
102
|
+
GW -- "자체 처리" --> AR["app routes<br/>plugins · 사용자 라우트"]
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
---
|
|
106
|
+
|
|
107
|
+
## 인증 흐름
|
|
108
|
+
|
|
109
|
+
### 프록시 요청 — JWT 패스스루
|
|
110
|
+
|
|
111
|
+
Frontend의 JWT를 그대로 Entity Server로 전달합니다.
|
|
112
|
+
Entity Server가 사용자 권한을 직접 검증합니다.
|
|
113
|
+
|
|
114
|
+
```mermaid
|
|
115
|
+
sequenceDiagram
|
|
116
|
+
participant FE as Frontend
|
|
117
|
+
participant GW as Gateway
|
|
118
|
+
participant ES as Entity Server
|
|
119
|
+
FE->>GW: 요청 (JWT 포함)
|
|
120
|
+
GW->>ES: 프록시 (JWT 그대로 전달)
|
|
121
|
+
ES-->>GW: 응답
|
|
122
|
+
GW-->>FE: 응답
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### 비즈니스 라우트 — JWT verify + HMAC
|
|
126
|
+
|
|
127
|
+
Gateway가 JWT를 직접 검증한 뒤, 비즈니스 로직을 수행합니다.
|
|
128
|
+
Entity Server 호출이 필요하면 HMAC API Key로 서버간 인증합니다.
|
|
129
|
+
|
|
130
|
+
```mermaid
|
|
131
|
+
sequenceDiagram
|
|
132
|
+
participant FE as Frontend
|
|
133
|
+
participant GW as Gateway
|
|
134
|
+
participant BL as 비즈니스 로직
|
|
135
|
+
participant ES as Entity Server
|
|
136
|
+
FE->>GW: 요청 (JWT 포함)
|
|
137
|
+
GW->>GW: JWT verify
|
|
138
|
+
GW->>BL: 처리
|
|
139
|
+
BL-->>ES: (필요 시) HMAC API Key
|
|
140
|
+
ES-->>BL: 응답
|
|
141
|
+
BL-->>FE: 응답
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## 훅 시스템
|
|
147
|
+
|
|
148
|
+
엔티티 CRUD 전/후에 커스텀 로직을 실행합니다.
|
|
149
|
+
Get 훅은 단건 조회 접근 제어/응답 가공(find 조회에도 afterGet 자동 적용),
|
|
150
|
+
Submit 훅은 `SubmitContext { old, new }`, Delete 훅은 `DeleteContext { seq, data }`를 받아 변경 전/후 데이터에 접근할 수 있습니다.
|
|
151
|
+
|
|
152
|
+
```mermaid
|
|
153
|
+
flowchart TD
|
|
154
|
+
REQ[요청] --> OLD["old 조회<br/>(UPDATE 시 기존 데이터 fetch)"]
|
|
155
|
+
OLD --> B["beforeSubmit(ctx)<br/>ctx = { old, new }"]
|
|
156
|
+
B --> ES[Entity Server submit]
|
|
157
|
+
ES --> REFETCH["new 재조회<br/>(저장된 결과 fetch)"]
|
|
158
|
+
REFETCH --> A["afterSubmit(ctx)<br/>ctx = { old, new }"]
|
|
159
|
+
A --> RES[응답]
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
| 훅 | 실패 시 | ctx |
|
|
163
|
+
| -------------- | ------------------------------------------- | ---------------------------------------------------- |
|
|
164
|
+
| `beforeGet` | 조회 차단 | `seq: number` |
|
|
165
|
+
| `afterGet` | 로그만 남기고 원본 반환 | `data: any` (조회된 데이터) |
|
|
166
|
+
| `beforeSubmit` | 요청 차단 (아직 Entity Server에 미반영) | `SubmitContext { old: 수정 전 \| null, new: 요청 }` |
|
|
167
|
+
| `afterSubmit` | 로그만 남기고 통과 (이미 반영됨, 롤백 불가) | `SubmitContext { old: 수정 전 \| null, new: 결과 }` |
|
|
168
|
+
| `beforeDelete` | 요청 차단 | `DeleteContext { seq, data: 삭제 대상 \| null }` |
|
|
169
|
+
| `afterDelete` | 로그만 남기고 통과 | `DeleteContext { seq, data: 삭제된 데이터 \| null }` |
|
|
170
|
+
|
|
171
|
+
- INSERT 시 `ctx.old = null`, UPDATE 시 `ctx.old`에 기존 데이터가 담깁니다.
|
|
172
|
+
- `beforeSubmit`의 반환값이 실제 submit 데이터가 됩니다.
|
|
173
|
+
|
|
174
|
+
훅 등록: `app/hooks/registry.ts`에 엔티티명을 키로 등록합니다.
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## 스케줄러
|
|
179
|
+
|
|
180
|
+
`app/schedules/{name}/index.ts`에서 `start()` 함수를 export하면 서버 시작 시 자동 로드됩니다.
|
|
181
|
+
|
|
182
|
+
분산 환경에서 중복 실행을 방지하기 위해 `acquireLock` / `releaseLock`을 사용합니다.
|
|
183
|
+
|
|
184
|
+
```ts
|
|
185
|
+
import { createCron, acquireLock, releaseLock } from "@gateway/api";
|
|
186
|
+
|
|
187
|
+
export async function start(): Promise<void> {
|
|
188
|
+
createCron("0 2 * * *", async () => {
|
|
189
|
+
const locked = await acquireLock("my-job", 300);
|
|
190
|
+
if (!locked) return;
|
|
191
|
+
try {
|
|
192
|
+
// 작업 수행
|
|
193
|
+
} finally {
|
|
194
|
+
await releaseLock("my-job");
|
|
195
|
+
}
|
|
196
|
+
});
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
기본 제공 스케줄:
|
|
201
|
+
|
|
202
|
+
| 스케줄 | 설명 |
|
|
203
|
+
| ---------------- | ------------------------------------------------ |
|
|
204
|
+
| `dormancy` | 장기 미접속 계정 휴면 전환 및 개인정보 처리 알림 |
|
|
205
|
+
| `data-retention` | 탈퇴 계정 개인정보 파기 처리 |
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## 코드 구조
|
|
210
|
+
|
|
211
|
+
```mermaid
|
|
212
|
+
graph LR
|
|
213
|
+
DIST["dist/"]
|
|
214
|
+
DIST --> SYS["system.js — 서버 코어 (난독화 번들, 수정 불가)"]
|
|
215
|
+
DIST --> SAPI["system-api.js — 공개 API 번들 (@gateway/api)"]
|
|
216
|
+
DIST --> APP["app/ — 사용자 편집 영역"]
|
|
217
|
+
DIST --> CFG["configs/ — JSON 설정 파일"]
|
|
218
|
+
DIST --> ENT["entities/ — 엔티티 스키마"]
|
|
219
|
+
DIST --> DOC["docs/ — 문서"]
|
|
220
|
+
DIST --> ENV[".env — 환경변수"]
|
|
221
|
+
APP --> EXT["plugins/{name}/index.ts — 플러그인 (자동 로드)"]
|
|
222
|
+
APP --> ETPL["plugins/{name}/templates/ — 플러그인 전용 템플릿"]
|
|
223
|
+
APP --> RT["routes/{name}/index.ts — 커스텀 라우트 (자동 등록)"]
|
|
224
|
+
APP --> RTPL["routes/{name}/templates/ — 라우트 전용 이메일 템플릿"]
|
|
225
|
+
APP --> HK["hooks/registry.ts — 엔티티 훅 등록"]
|
|
226
|
+
APP --> SC["schedules/{name}/index.ts — 스케줄러 (자동 로드)"]
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
### system.js vs app/
|
|
230
|
+
|
|
231
|
+
| | system.js | app/ |
|
|
232
|
+
| --------- | -------------------------------------------- | --------------- |
|
|
233
|
+
| 역할 | 서버 코어 (프록시, 인증, 미들웨어, 플러그인) | 비즈니스 로직 |
|
|
234
|
+
| 배포 형태 | 난독화 번들 | TypeScript 소스 |
|
|
235
|
+
| 수정 가능 | ✗ | ✓ |
|
|
236
|
+
|
|
237
|
+
### @gateway/api
|
|
238
|
+
|
|
239
|
+
app 코드에서 시스템 기능을 사용하기 위한 공개 API입니다.
|
|
240
|
+
|
|
241
|
+
```ts
|
|
242
|
+
import { ok, fail, logger, entityServer } from "@gateway/api";
|
|
243
|
+
import { NotFoundError, BadRequestError } from "@gateway/api";
|
|
244
|
+
import type { EntityHook } from "@gateway/api";
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
| export | 설명 |
|
|
248
|
+
| ----------------------------------------- | ----------------------------------------------- |
|
|
249
|
+
| `ok(data, requestId?)` | 성공 응답 `{ success: true, data }` |
|
|
250
|
+
| `fail(error, requestId?)` | 실패 응답 `{ success: false, error }` |
|
|
251
|
+
| `logger` | pino 로거 |
|
|
252
|
+
| `logFmt` | ANSI 컬러 로그 포맷 유틸리티 |
|
|
253
|
+
| `env` | 환경변수 객체 |
|
|
254
|
+
| `serverConfig` | 서버 설정 (port, host, baseUrl 등) |
|
|
255
|
+
| `entityServer` | Entity Server REST 클라이언트 (HMAC 내장) |
|
|
256
|
+
| `ensurePluginEntities` | 플러그인 엔티티 스키마 자동 등록 |
|
|
257
|
+
| `sendEmail` | 이메일 발송 (`SendEmailParams`) |
|
|
258
|
+
| `sendPush` / `sendPushAll` | 푸시 알림 발송 |
|
|
259
|
+
| `registerPushService` | 푸시 서비스 레퍼런스 등록 |
|
|
260
|
+
| `cache` | 캐시 스토어 (`CacheStore`) |
|
|
261
|
+
| `acquireLock` / `releaseLock` | 분산 락 (스케줄러 중복 실행 방지) |
|
|
262
|
+
| `createCron` / `validateCron` | Cron 스케줄러 유틸리티 |
|
|
263
|
+
| `describeCron` / `nextRuns` | Cron 설명·다음 실행 시각 조회 |
|
|
264
|
+
| `dbConn(group?)` | Kysely DB 인스턴스 반환 (group 생략 시 default) |
|
|
265
|
+
| `sql` | Kysely SQL 템플릿 태그 |
|
|
266
|
+
| `AppError` | 에러 베이스 클래스 (statusCode 포함) |
|
|
267
|
+
| `BadRequestError` / `NotFoundError` / ... | HTTP 에러 클래스 (400, 404, ...) |
|
|
268
|
+
| `sha256` / `hmacSha256` / `encryptAesCbc` | 암호화 유틸리티 |
|
|
269
|
+
| `hashString` / `hashBuffer` | SHA-256 해시 유틸리티 |
|
|
270
|
+
| `fetchWithTimeout` / `fetchJson` | HTTP 클라이언트 유틸 |
|
|
271
|
+
| `toNumber` / `toString` / `toBool` | 타입 변환 유틸 |
|
|
272
|
+
| `generateVerificationCode` | 인증 코드 생성 |
|
|
273
|
+
| `validatePassword` / `loadPasswordPolicy` | 비밀번호 정책 검증·로드 |
|
|
274
|
+
| `registerWithdrawHook` | 회원 탈퇴 훅 등록 |
|
|
275
|
+
| `setSharedLayout` / `renderTemplate` | 이메일 템플릿 엔진 (Handlebars 기반) |
|
|
276
|
+
| `substituteEnvVars` | `${ENV}` 형태 환경변수 치환 |
|
|
277
|
+
| `loadJsonConfig` | JSON 설정 파일 로더 |
|
|
278
|
+
| `normalizePhoneE164` / `formatBizNum` | 전화번호·사업자번호 포맷 유틸리티 |
|
|
279
|
+
| `EntityHook` | 훅 인터페이스 (type) |
|
|
280
|
+
| `SubmitContext` | submit 훅 old/new 컨텍스트 (type) |
|
|
281
|
+
| `DeleteContext` | delete 훅 seq/data 컨텍스트 (type) |
|
|
282
|
+
| `UserInfo` | JWT 사용자 정보 (type) |
|
|
283
|
+
| `SendEmailParams` | 이메일 발송 파라미터 (type) |
|
|
284
|
+
| `PasswordPolicy` | 비밀번호 정책 (type) |
|
|
285
|
+
|
|
286
|
+
---
|
|
287
|
+
|
|
288
|
+
## 데이터 접근 전략
|
|
289
|
+
|
|
290
|
+
| 방법 | 용도 | 예시 |
|
|
291
|
+
| --------------------- | ------------------------------ | ---------------------------- |
|
|
292
|
+
| `entityServer` (HMAC) | 표준 엔티티 CRUD | 사용자 조회, 주문 생성 |
|
|
293
|
+
| `app.db` (직접 쿼리) | 복잡한 집계, JOIN, 일반 테이블 | 대시보드, 리포트, idx 테이블 |
|
|
294
|
+
|
|
295
|
+
**원칙**: 가능하면 `entityServer`를 우선 사용하고, 복잡한 쿼리가 필요할 때만 `app.db`를 사용합니다.
|