@xfilecom/create-xframe 0.1.0 → 0.1.1

package/bin/create-xframe.js

@@ -154,6 +154,7 @@ function main() {
   }
 
   console.log(`Created ${packageName} at ${targetRoot}
+YAML: shared/config/api · shared/schema|sql|endpoint 자리 포함
 Next:
   cd ${projectDir}
   npm install

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@xfilecom/create-xframe",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Scaffold a Nest app wired to @xfilecom/backend-core (xframe)",
   "license": "UNLICENSED",
   "bin": {
     "create-xframe": "bin/create-xframe.js"
   },
-  "files": ["bin", "template"],
+  "files": [
+    "bin",
+    "template"
+  ],
   "engines": {
     "node": ">=18"
   },
@@ -14,5 +17,11 @@
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "keywords": ["xframe", "nestjs", "xfilecom", "scaffold", "create-xframe"]
+  "keywords": [
+    "xframe",
+    "nestjs",
+    "xfilecom",
+    "scaffold",
+    "create-xframe"
+  ]
 }

package/template/shared/README.md

@@ -0,0 +1,8 @@
+# `shared/` — 설정·도메인 자산
+
+| 경로 | 용도 |
+|------|------|
+| **`config/api`** | Nest API YAML (`loadApplicationYamlSync` → `src/config.loader.ts`) |
+| **`schema/`** | Drizzle 스키마 등 (TS는 `tsconfig.build.json`에 경로 포함 필요) |
+| **`sql/`** | 마이그레이션·시드 SQL |
+| **`endpoint/`** | OpenAPI·공유 DTO·라우트 규칙 |

package/template/shared/config/api/application-development.yml

@@ -0,0 +1,2 @@
+app:
+  env: development

package/template/shared/config/api/application-production.yml

@@ -0,0 +1,2 @@
+app:
+  env: production

package/template/shared/config/api/application-staging.yml

@@ -0,0 +1,2 @@
+app:
+  env: staging

package/template/shared/config/api/application.yml

@@ -0,0 +1,21 @@
+server:
+  port: 3000
+
+cors:
+  enabled: true
+  origin: true
+
+core:
+  database:
+    auto: false
+  interceptors:
+    logging: true
+    errorHandling: true
+    responseTransform: true
+    databaseCheck: true
+  response:
+    commonResponse: true
+  filters:
+    exception: true
+  guards:
+    jwt: false

package/template/shared/endpoint/README.md

@@ -0,0 +1 @@
+OpenAPI·공유 endpoint 계약.

package/template/shared/schema/README.md

@@ -0,0 +1 @@
+Drizzle 등 DB 스키마. `AppModule`에서 import 후 `database: { auto: true, schema }`에 연결. TS 파일을 여기 두면 `tsconfig.build.json`의 `include`에 `shared/schema/**/*.ts`를 추가하세요.

package/template/shared/sql/README.md

@@ -0,0 +1 @@
+마이그레이션·시드 SQL 보관.

package/template/src/app.module.ts

@@ -1,14 +1,32 @@
 import { Module } from '@nestjs/common';
-import { CoreModule } from '@xfilecom/backend-core';
+import { CoreModule, type CoreModuleOptions } from '@xfilecom/backend-core';
+import { appConfig } from './config.loader';
 import { AppController } from './app.controller';
+// import { schema } from '../shared/schema';
 
-@Module({
-  imports: [
-    CoreModule.forHttpApi({
+function coreOptionsFromYaml(): CoreModuleOptions {
+  const c = appConfig.core;
+  if (!c) {
+    return {
       database: { auto: false },
       guards: { jwt: false },
-    }),
-  ],
+    };
+  }
+  return {
+    database: {
+      auto: c.database?.auto === true,
+      // schema,
+    },
+    interceptors: c.interceptors,
+    response: c.response,
+    filters: c.filters,
+    guards: c.guards,
+    jwt: c.jwt,
+  };
+}
+
+@Module({
+  imports: [CoreModule.forHttpApi(coreOptionsFromYaml())],
   controllers: [AppController],
 })
 export class AppModule {}

package/template/src/config.loader.ts

@@ -0,0 +1,43 @@
+import { resolve } from 'path';
+import {
+  loadApplicationYamlSync,
+  type ConfigSource,
+} from '@xfilecom/backend-core';
+
+const configDir = resolve(process.cwd(), 'shared', 'config', 'api');
+const nodeEnv = process.env.NODE_ENV || 'development';
+const configSource =
+  (process.env.CONFIG_SOURCE as ConfigSource | undefined) ?? 'yamlWithEnvOverrides';
+
+export const appConfig = loadApplicationYamlSync({
+  rootDir: configDir,
+  env: nodeEnv,
+  configSource,
+  syncEnvKeys: {
+    PORT: 'server.port',
+    APP_ENV: 'app.env',
+  },
+}) as AppConfigShape;
+
+export type AppConfigShape = {
+  server?: { port?: number };
+  app?: { env?: string };
+  cors?: {
+    enabled?: boolean;
+    origin?: boolean | string | string[];
+    credentials?: boolean;
+  };
+  core?: {
+    database?: { auto?: boolean };
+    interceptors?: {
+      logging?: boolean | Record<string, unknown>;
+      errorHandling?: boolean;
+      responseTransform?: boolean;
+      databaseCheck?: boolean;
+    };
+    response?: { commonResponse?: boolean };
+    filters?: { exception?: boolean | Record<string, unknown> };
+    guards?: { jwt?: boolean };
+    jwt?: { secret?: string; expiresIn?: string };
+  };
+};

package/template/src/main.ts

@@ -1,9 +1,27 @@
+import './config.loader';
 import 'reflect-metadata';
 import { NestFactory } from '@nestjs/core';
+import type { INestApplication } from '@nestjs/common';
 import { AppModule } from './app.module';
+import { appConfig } from './config.loader';
+
+function applyCors(app: INestApplication): void {
+  const cors = appConfig.cors;
+  if (cors?.enabled === false) {
+    return;
+  }
+  const origin = cors?.origin ?? true;
+  const credentials = cors?.credentials === true;
+  if (Array.isArray(origin) || typeof origin === 'string') {
+    app.enableCors({ origin, credentials });
+    return;
+  }
+  app.enableCors({ origin: origin === true, credentials });
+}
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
+  applyCors(app);
   const port = Number(process.env.PORT) || 3000;
   await app.listen(port);
 }