@bstage-sdk/cli 0.1.0 → 0.3.0

package/dist/MIGRATION.md

@@ -45,6 +45,35 @@
 
 > **`적용` 단계는 옛 프로젝트에서 실제로 따라가 본 뒤 적는다.** 새 `bstage init` 프로젝트에서 되는 것과, 기존 프로젝트가 이 절차만 보고 도달하는 것은 다르다. 따라 했을 때 깨지는 선행 조건이 있으면 **그 조건까지 적는다** — `core 0.44.0` 항목이 그 사례다(스크립트만 넣으면 `@types/node` 부재로 `TS2688`이 난다. 스캐폴드 템플릿을 고쳐 새 프로젝트는 해결됐지만, 먼저 써둔 적용 절차를 되짚지 않아 기존 프로젝트용 지침이 깨진 채 남았다).
 
-> **헤더 규칙**: `
+> **헤더 규칙**: `## → {패키지} {버전}` 형식으로, 그 변경을 실제로 낸 패키지와 버전을 명시한다(예: `→ cli 0.3.0`, `→ core 0.3.0`). 한 변경이 여러 패키지를 함께 범프시켰으면 소비자가 올려야 할 패키지를 `·`로 나열한다(예: `→ core 0.3.0 · cli 0.3.0`). 소비자는 이 헤더의 패키지를 해당 버전 **이상**으로 올려야 한다. 단순 의존성 재핀(dependency bump)만 된 패키지는 헤더에 적지 않는다.
+>
+> **정렬**: 릴리즈 **시점 최신이 위**. 패키지가 독립 버전이라 헤더 숫자만으로는 시간순 정렬이 되지 않으므로 릴리즈 순서를 기준으로 한다.
 
-아직 항목이 없다. 소비자에게 영향이 있는 변경을 릴리즈할 때 여기에 추가한다.
+---
+## → core 0.3.0 · cli 0.3.0
+
+### 앱 키 이름 정리(`appSecret` → `appKey`, `VITE_BSTAGE_APP_SECRET` → `VITE_BSTAGE_APP_KEY`) — `판단` · `선택`
+
+**영향**
+
+- **기존 프로젝트가 반드시 할 일은 없다.** `appSecret`·`VITE_BSTAGE_APP_SECRET`은 deprecated 별칭으로 그대로 동작한다. 별칭은 **0.4.0**에서 제거되므로 그 전에 옮긴다.
+- 감지: `src/shared/client.ts`에 `appSecret:`이 있거나, `.env`·`.env.example`에 `VITE_BSTAGE_APP_SECRET`이 있는 경우.
+
+**변경 내용**
+
+- 같은 값을 포털 화면(APP KEY)·포털 API(`appKey`)·게이트웨이 헤더(`X-BSTAGE-APP-KEY`)는 모두 KEY라고 부르는데 SDK만 `secret`이라고 불렀다. 이 값은 `VITE_` 환경변수라 **빌드 결과물에 평문으로 실려 브라우저에서 보이는 값**이고 비밀값이 아니다 — 이름이 사실과 반대여서 "숨겨야 하는 값"으로 오해하게 했다. SDK 이름을 나머지와 맞췄다.
+- `BstageConfig.appKey`가 정본이고 `appSecret`은 deprecated 별칭이다(둘 다 주면 `appKey` 우선). 타입 주석도 "앱 시크릿"에서 "앱 키(APP KEY) — 브라우저에 노출되는 값"으로 바꿨다.
+- 새 `bstage init` 스캐폴드는 `.env`·`.env.example`·`client.ts`·`vite-env.d.ts`에 새 이름을 쓴다.
+- **소스와 `.env`가 다른 이름을 써도 빌드가 이어 붙인다.** `bstage build`(프리셋)와 `bstageDevPlugin`이 `VITE_BSTAGE_APP_KEY`·`VITE_BSTAGE_APP_SECRET` 중 한쪽만 있으면 다른 이름으로도 같은 값이 읽히게 `define`한다. 그래서 옛 `client.ts`(`appSecret: import.meta.env.VITE_BSTAGE_APP_SECRET`)를 둔 채 `.env`만 새 이름으로 바꿔도, 포털의 환경변수 입력이 새 이름으로 들어와도 번들에 값이 실린다. 둘 다 있으면 각자 실제 값이 그대로 쓰인다.
+- `bstage build`의 인증 값 점검도 같은 순서로 본다 — 소스가 읽는 이름의 값이 우선, 다른 이름은 폴백. 보고에는 소스가 실제로 읽는 이름을 쓴다.
+- 앱 키가 아예 없으면 `X-BSTAGE-APP-KEY` 헤더에 `"undefined"` 문자열을 실던 것을 헤더 생략 + 생성 시 콘솔 경고로 바꿨다. 게이트웨이 응답(401)은 같다.
+
+**적용**
+
+1. (자동) `@bstage-sdk/core`·`@bstage-sdk/cli`를 `0.3.0` 이상으로 올린다.
+2. (판단) `src/shared/client.ts`의 `appSecret: import.meta.env.VITE_BSTAGE_APP_SECRET`을 `appKey: import.meta.env.VITE_BSTAGE_APP_KEY`로 바꾼다. 리터럴 키를 박아 둔 옛 프로젝트는 키 이름만 `appSecret` → `appKey`로 바꾼다.
+3. (판단) `.env`·`.env.example`의 `VITE_BSTAGE_APP_SECRET=`을 `VITE_BSTAGE_APP_KEY=`로 바꾼다. 값은 그대로다 — 재발급이 아니다.
+4. (판단) `src/vite-env.d.ts`의 `readonly VITE_BSTAGE_APP_SECRET: string`을 `readonly VITE_BSTAGE_APP_KEY: string`으로 바꾼다.
+5. CI·배포 환경에 `VITE_BSTAGE_APP_SECRET`을 주입하고 있었다면 같은 값을 `VITE_BSTAGE_APP_KEY`로 주입한다. 2~4를 한 번에 못 옮기는 기간에는 위 별칭 덕에 어느 한쪽 이름만 있어도 빌드가 통과한다.
+
+---

package/dist/{chunk-S6HGR2U3.js → chunk-COUDGZIA.js}

@@ -2,14 +2,14 @@
 import { defineConfig } from "vite";
 import react from "@vitejs/plugin-react";
 
-// src/dev/devVitePlugin.ts
-import { createRequire } from "module";
-import { readFileSync as readFileSync2 } from "fs";
-import { join, dirname } from "path";
+// src/vite/appKeyEnvAlias.ts
+import { loadEnv } from "vite";
 
 // src/constants.ts
 import { readFileSync } from "fs";
 import { resolve } from "path";
+var APP_KEY_VAR = "VITE_BSTAGE_APP_KEY";
+var LEGACY_APP_KEY_VAR = "VITE_BSTAGE_APP_SECRET";
 var BSTAGE_INTERNAL_PREFIX = "/__bstage__";
 var LOGIN_PATH = `${BSTAGE_INTERNAL_PREFIX}/login`;
 var PROXY_PATH_PREFIX = "/__proxy__";
@@ -65,6 +65,11 @@ var DEFAULT_TRANSLATION_TIER = "inhouse";
 var TRANSLATION_CDN_ORIGIN = "https://cdn.static.bstage.in";
 var TRANSLATION_CDN_BASE_KEY = "static/i18n";
 var TRANSLATION_CDN_BUCKET_PREFIX = "cdn.bstage.in/";
+var PORTAL_HOSTS = {
+  real: "portal.bstage.in",
+  sandbox: "bstage-portal.sandbox.bstage.systems"
+};
+var PORTAL_HOST_ENV_KEY = "VITE_BSTAGE_PORTAL_HOST";
 function getAuthHost(mode, phase, tenantId) {
   if (mode === "admin") {
     const fn2 = ADMIN_AUTH_HOSTS[phase];
@@ -83,6 +88,31 @@ function resolveProjectTarget(root) {
   return pkg.bstage?.target === "admin" ? "admin" : "user";
 }
 
+// src/vite/appKeyEnvAlias.ts
+function appKeyEnvDefine(env) {
+  const key = env[APP_KEY_VAR]?.trim();
+  const legacy = env[LEGACY_APP_KEY_VAR]?.trim();
+  if (key && !legacy) return { [`import.meta.env.${LEGACY_APP_KEY_VAR}`]: JSON.stringify(key) };
+  if (legacy && !key) return { [`import.meta.env.${APP_KEY_VAR}`]: JSON.stringify(legacy) };
+  return {};
+}
+function loadProjectEnv(config, mode) {
+  return loadEnv(mode, config.envDir ?? config.root ?? process.cwd(), "VITE_");
+}
+function appKeyEnvAliasPlugin() {
+  return {
+    name: "bstage-app-key-env-alias",
+    config(config, { mode }) {
+      return { define: appKeyEnvDefine(loadProjectEnv(config, mode)) };
+    }
+  };
+}
+
+// src/dev/devVitePlugin.ts
+import { createRequire } from "module";
+import { readFileSync as readFileSync2 } from "fs";
+import { join, dirname } from "path";
+
 // src/dev/loginPage.ts
 function getLoginPageHtml(phase, mode = "user") {
   const tokenPath = AUTH_TOKEN_PATH_BY_MODE[mode].replace(/^\/svc/, AUTH_PATH_PREFIX);
@@ -410,14 +440,14 @@ function getLoginPageHtml(phase, mode = "user") {
 // src/dev/proxyUtils.ts
 import { request as httpsRequest } from "https";
 import { gunzipSync, brotliDecompressSync, inflateSync } from "zlib";
-import { loadEnv } from "vite";
+import { loadEnv as loadEnv2 } from "vite";
 var CF_ACCESS_ENV_KEYS = ["VITE_CF_ACCESS_CLIENT_ID", "VITE_CF_ACCESS_CLIENT_SECRET"];
 var cachedCreds;
 var missingWarned = false;
 function resolveCfAccessCreds() {
   if (cachedCreds !== void 0) return cachedCreds;
   const [idKey, secretKey] = CF_ACCESS_ENV_KEYS;
-  const fileEnv = loadEnv("development", process.cwd(), "");
+  const fileEnv = loadEnv2("development", process.cwd(), "");
   const id = process.env[idKey] || fileEnv[idKey] || "";
   const secret = process.env[secretKey] || fileEnv[secretKey] || "";
   cachedCreds = id && secret ? { id, secret } : null;
@@ -513,16 +543,31 @@ function stripResponseCookies(headers, extraCookies) {
     headers["set-cookie"] = cookies;
   }
 }
-function collectBody(req) {
-  return new Promise((resolve2) => {
+var MAX_REQUEST_BODY_BYTES = 10 * 1024 * 1024;
+function collectBody(req, maxBytes = MAX_REQUEST_BODY_BYTES) {
+  return new Promise((resolve2, reject) => {
     const chunks = [];
-    req.on("data", (c) => chunks.push(c));
-    req.on("end", () => resolve2(Buffer.concat(chunks)));
+    let total = 0;
+    let overflowed = false;
+    req.on("data", (c) => {
+      if (overflowed) return;
+      total += c.length;
+      if (total > maxBytes) {
+        overflowed = true;
+        chunks.length = 0;
+        reject(new Error(`Request body exceeds ${maxBytes} bytes`));
+        return;
+      }
+      chunks.push(c);
+    });
+    req.on("end", () => {
+      if (!overflowed) resolve2(Buffer.concat(chunks));
+    });
   });
 }
 
 // src/dev/resolveHosts.ts
-import { loadEnv as loadEnv2 } from "vite";
+import { loadEnv as loadEnv3 } from "vite";
 var HOST_ENV_KEYS = {
   gateway: "VITE_BSTAGE_GATEWAY_HOST",
   auth: "VITE_BSTAGE_AUTH_HOST",
@@ -539,7 +584,7 @@ function resolveDevHosts(phase, mode, cwd = process.cwd()) {
       auth: (tenantId) => getAuthHost(mode, phase, tenantId)
     };
   }
-  const fileEnv = loadEnv2("development", cwd, "");
+  const fileEnv = loadEnv3("development", cwd, "");
   const read = (key) => (process.env[key] || fileEnv[key] || "").trim();
   const authKey = authKeyFor(mode);
   const gatewayHost = read(HOST_ENV_KEYS.gateway);
@@ -562,13 +607,13 @@ function resolveDevHosts(phase, mode, cwd = process.cwd()) {
 }
 
 // src/dev/resolvePhase.ts
-import { loadEnv as loadEnv3 } from "vite";
+import { loadEnv as loadEnv4 } from "vite";
 var PHASES = ["dev", "qa", "real", "sandbox"];
 var DEFAULT_PHASE = "sandbox";
 function isPhase(value) {
   return PHASES.includes(value);
 }
-function resolvePhase(explicit, cwd = process.cwd()) {
+function resolvePhase(explicit, cwd = process.cwd(), env = process.env) {
   if (explicit) {
     if (!isPhase(explicit)) {
       throw new Error(
@@ -577,8 +622,8 @@ function resolvePhase(explicit, cwd = process.cwd()) {
     }
     return { phase: explicit, source: "flag" };
   }
-  const fileEnv = loadEnv3("development", cwd, "");
-  const fromEnv = process.env.VITE_BSTAGE_PHASE || fileEnv.VITE_BSTAGE_PHASE || "";
+  const fileEnv = loadEnv4("development", cwd, "");
+  const fromEnv = env.VITE_BSTAGE_PHASE || fileEnv.VITE_BSTAGE_PHASE || "";
   if (fromEnv) {
     if (isPhase(fromEnv)) return { phase: fromEnv, source: "env" };
     return { phase: DEFAULT_PHASE, source: "default", ignoredEnvValue: fromEnv };
@@ -1729,13 +1774,13 @@ async function refreshAccessToken(mode, phase, hosts, tenantId, accessToken, coo
       headers,
       body: Buffer.from(postBody)
     });
-    const text = result.body.toString("utf-8");
-    const json = JSON.parse(text);
-    if (result.statusCode === 200 && json.accessToken) {
+    const json = JSON.parse(result.body.toString("utf-8"));
+    const newToken = json.accessToken ?? json.data?.accessToken;
+    if (result.statusCode === 200 && newToken) {
       console.info(`[bstage] token refreshed (${mode})`);
-      return json.accessToken;
+      return newToken;
     }
-    console.warn("[bstage] token refresh failed:", result.statusCode, text);
+    console.warn(`[bstage] token refresh failed (mode=${mode}, status=${result.statusCode})`);
     return null;
   } catch {
     return null;
@@ -1821,10 +1866,15 @@ function handleGatewayProxy(mode, phase, hosts, req, res) {
       res.writeHead(result.statusCode, result.headers);
       res.end(result.body);
     } catch (err) {
-      const message = err instanceof Error ? err.message : String(err);
+      console.error("[bstage] gateway proxy error:", err instanceof Error ? err.message : err);
       res.writeHead(502, { "Content-Type": "application/json" });
-      res.end(JSON.stringify({ message: "Gateway proxy error", error: message }));
+      res.end(JSON.stringify({ message: "Gateway proxy error" }));
     }
+  }).catch((err) => {
+    console.error("[bstage] request body rejected:", err instanceof Error ? err.message : err);
+    if (res.headersSent) return;
+    res.writeHead(413, { "Content-Type": "application/json" });
+    res.end(JSON.stringify({ message: "Request body too large" }));
   });
 }
 function subpathOf(source) {
@@ -1895,18 +1945,22 @@ function handleAuthProxy(mode, phase, hosts, req, res) {
         }
       } else {
         console.warn(
-          `[bstage] auth proxy upstream non-2xx (mode=${mode}, status=${result.statusCode}):`,
-          textBody.slice(0, 500)
+          `[bstage] auth proxy upstream non-2xx (mode=${mode}, status=${result.statusCode})`
         );
       }
       stripResponseCookies(result.headers, extraCookies);
       res.writeHead(result.statusCode, result.headers);
       res.end(textBody);
     } catch (err) {
-      const message = err instanceof Error ? err.message : String(err);
+      console.error("[bstage] auth proxy error:", err instanceof Error ? err.message : err);
       res.writeHead(502, { "Content-Type": "application/json" });
-      res.end(JSON.stringify({ message: "Auth proxy error", error: message }));
+      res.end(JSON.stringify({ message: "Auth proxy error" }));
     }
+  }).catch((err) => {
+    console.error("[bstage] request body rejected:", err instanceof Error ? err.message : err);
+    if (res.headersSent) return;
+    res.writeHead(413, { "Content-Type": "application/json" });
+    res.end(JSON.stringify({ message: "Request body too large" }));
   });
 }
 function bstageDevPlugin(options = {}) {
@@ -1920,10 +1974,13 @@ function bstageDevPlugin(options = {}) {
   return {
     name: "bstage-dev",
     enforce: "pre",
-    config() {
+    config(config, { mode: mode2 }) {
       const root = process.cwd();
       projectRequire = createRequire(join(root, "package.json"));
       return {
+        // 앱 키 env 별칭 — 소비자 `vite.config.ts`는 이 플러그인만 얹으므로 여기서도 이어 붙인다
+        // (`bstage build`는 프리셋이 맡는다). 상세는 appKeyEnvAlias.ts.
+        define: appKeyEnvDefine(loadProjectEnv(config, mode2)),
         optimizeDeps: {
           exclude: ["@bstage-sdk/core", "@bstage-sdk/react"]
         },
@@ -2035,7 +2092,7 @@ function bstageDevPlugin(options = {}) {
 // src/vite/preset.ts
 function createViteConfig(options = {}) {
   return defineConfig({
-    plugins: [react()],
+    plugins: [react(), appKeyEnvAliasPlugin()],
     define: {
       "process.env.NODE_ENV": JSON.stringify("production")
     },
@@ -2062,13 +2119,20 @@ function createViteConfig(options = {}) {
 }
 
 export {
+  APP_KEY_VAR,
+  LEGACY_APP_KEY_VAR,
   LOGIN_PATH,
+  isPublicPhase,
   TRANSLATION_LANGUAGES,
   DEFAULT_TRANSLATION_TIER,
   TRANSLATION_CDN_ORIGIN,
   TRANSLATION_CDN_BASE_KEY,
   TRANSLATION_CDN_BUCKET_PREFIX,
+  PORTAL_HOSTS,
+  PORTAL_HOST_ENV_KEY,
   resolveProjectTarget,
+  appKeyEnvDefine,
+  appKeyEnvAliasPlugin,
   resolvePhase,
   describePhase,
   bstageDevPlugin,