connectbase-client 0.11.0 → 0.12.0

package/README.md

@@ -12,9 +12,9 @@ pnpm add connectbase-client
 yarn add connectbase-client
 ```
 
-## API Key Types
+## Key Types
 
-Connect Base provides **two types** of API Keys. Use the right key for your use case:
+Connect Base provides **two types** of Keys. Use the right key for your use case:
 
 | Type | Prefix | Use For | Permissions | Safe to Expose? |
 |------|--------|---------|-------------|-----------------|
@@ -26,7 +26,7 @@ Connect Base provides **two types** of API Keys. Use the right key for your use
 | Context | Key Type | Example |
 |---------|----------|---------|
 | Frontend SDK (`new ConnectBase()`) | **Public Key** (`cb_pk_`) | Web/app: DB queries, auth, file uploads |
-| `.env` file (`VITE_CONNECTBASE_API_KEY`) | **Public Key** (`cb_pk_`) | React, Vue, etc. |
+| `.env` file (`VITE_CONNECTBASE_PUBLIC_KEY`) | **Public Key** (`cb_pk_`) | React, Vue, etc. |
 | CLI deploy (`.connectbaserc`) | **Public Key** (`cb_pk_`) | `npx connectbase deploy` |
 | MCP server (AI tools) | **Secret Key** (`cb_sk_`) | Claude, Cursor, Windsurf |
 | Server-side admin tasks | **Secret Key** (`cb_sk_`) | Backend full data access |
@@ -35,7 +35,7 @@ Connect Base provides **two types** of API Keys. Use the right key for your use
 >
 > ⚠️ **Never use Secret Keys in frontend code** — RLS is bypassed, exposing all data.
 
-Create API Keys in the Console under **Settings > API tab**. Choose Public or Secret type when creating. The full key is shown **only once** at creation time.
+Create Keys in the Console under **Settings > API tab**. Choose Public or Secret type when creating. The full key is shown **only once** at creation time.
 
 ## Quick Start
 
@@ -44,7 +44,7 @@ import ConnectBase from 'connectbase-client'
 
 // Initialize the SDK — use a Public Key (cb_pk_)
 const cb = new ConnectBase({
-  apiKey: 'cb_pk_your-public-key'
+  publicKey: 'cb_pk_your-public-key'
 })
 
 // Create a game room client
@@ -96,7 +96,7 @@ npm run deploy
 ```
 
 The `init` command will:
-- Ask for your API Key
+- Ask for your Public Key
 - List existing web storages or create a new one automatically
 - Create a `.connectbaserc` config file
 - Add `.connectbaserc` to `.gitignore`
@@ -115,7 +115,7 @@ The `init` command will:
 If you prefer not to use `init`, you can pass options directly:
 
 ```bash
-npx connectbase-client deploy ./dist -s <storage-id> -k <api-key>
+npx connectbase-client deploy ./dist -s <storage-id> -k <public-key>
 ```
 
 ### Options
@@ -123,7 +123,7 @@ npx connectbase-client deploy ./dist -s <storage-id> -k <api-key>
 | Option | Alias | Description |
 |--------|-------|-------------|
 | `--storage <id>` | `-s` | Storage ID |
-| `--api-key <key>` | `-k` | API Key |
+| `--public-key <key>` | `-k` | API Key |
 | `--base-url <url>` | `-u` | Custom server URL |
 | `--timeout <sec>` | `-t` | Tunnel request timeout in seconds (tunnel only) |
 | `--max-body <MB>` | | Tunnel max body size in MB (tunnel only) |
@@ -136,10 +136,10 @@ Expose a local server to the internet through a secure WebSocket tunnel. Useful
 
 ```bash
 # Expose local port 8084 to the internet
-npx connectbase-client tunnel 8084 -k <api-key>
+npx connectbase-client tunnel 8084 -k <public-key>
 
 # With environment variable
-export CONNECTBASE_API_KEY=your-api-key
+export CONNECTBASE_PUBLIC_KEY=your-public-key
 npx connectbase-client tunnel 8084
 
 # For GPU servers or long-running tasks (e.g., image generation)
@@ -170,7 +170,7 @@ The `init` command creates `.connectbaserc` automatically. You can also create i
 
 ```json
 {
-  "apiKey": "your-api-key",
+  "publicKey": "your-public-key",
   "storageId": "your-storage-id",
   "deployDir": "./dist"
 }
@@ -179,7 +179,7 @@ The `init` command creates `.connectbaserc` automatically. You can also create i
 ### Environment Variables
 
 ```bash
-export CONNECTBASE_API_KEY=your-api-key
+export CONNECTBASE_PUBLIC_KEY=your-public-key
 export CONNECTBASE_STORAGE_ID=your-storage-id
 npx connectbase-client deploy ./dist
 ```
@@ -780,7 +780,7 @@ await cb.push.unsubscribeFromTopic('news')
 ### WebRTC
 
 ```typescript
-// API Key/JWT 유효성 사전 검증
+// Public Key/JWT 유효성 사전 검증
 const result = await cb.webrtc.validate()
 if (result.valid) {
   console.log('인증 성공:', result.app_id)
@@ -939,7 +939,7 @@ setInterval(async () => {
 ```typescript
 import ConnectBase from 'connectbase-client'
 
-const cb = new ConnectBase({ apiKey: 'your-api-key' })
+const cb = new ConnectBase({ publicKey: 'your-public-key' })
 const game = cb.game.createClient({ clientId: `player-${Date.now()}` })
 
 // Local player state

package/dist/cli.js

@@ -113,9 +113,8 @@ var BINARY_EXTENSIONS = /* @__PURE__ */ new Set([
 ]);
 function loadConfig() {
   const config = {
-    publicKey: process.env.CONNECTBASE_PUBLIC_KEY ?? process.env.CONNECTBASE_API_KEY,
+    publicKey: process.env.CONNECTBASE_PUBLIC_KEY,
     secretKey: process.env.CONNECTBASE_SECRET_KEY,
-    apiKey: process.env.CONNECTBASE_API_KEY,
     storageId: process.env.CONNECTBASE_STORAGE_ID,
     baseUrl: process.env.CONNECTBASE_BASE_URL || DEFAULT_BASE_URL
   };
@@ -125,14 +124,6 @@ function loadConfig() {
       const rcContent = JSON.parse(fs.readFileSync(rcPath, "utf-8"));
       if (rcContent.publicKey) config.publicKey = rcContent.publicKey;
       if (rcContent.secretKey) config.secretKey = rcContent.secretKey;
-      if (rcContent.apiKey && !config.publicKey && !config.secretKey) {
-        if (rcContent.apiKey.startsWith("cb_sk_")) {
-          config.secretKey = rcContent.apiKey;
-        } else {
-          config.publicKey = rcContent.apiKey;
-        }
-      }
-      if (rcContent.apiKey) config.apiKey = rcContent.apiKey;
       if (rcContent.storageId) config.storageId = rcContent.storageId;
       if (rcContent.baseUrl) config.baseUrl = rcContent.baseUrl;
       if (rcContent.deployDir) config.deployDir = rcContent.deployDir;
@@ -266,7 +257,7 @@ async function deploy(directory, config, isDev = false) {
       url,
       "POST",
       {
-        "X-Public-Key": config.publicKey ?? config.apiKey
+        "X-Public-Key": config.publicKey ?? config.publicKey
       },
       JSON.stringify({
         files: files.map((f) => ({
@@ -533,7 +524,7 @@ ${colors.blue}?${colors.reset} \uC120\uD0DD (\uBC88\uD638): `);
         success(`\uC120\uD0DD\uB428: ${apps[num - 1].name}`);
         info("Public Key \uC0DD\uC131 \uC911...");
         const newKeyRes = await makeRequest(
-          `${DEFAULT_BASE_URL}/v1/public/cli/apps/${appId}/api-keys/public`,
+          `${DEFAULT_BASE_URL}/v1/public/cli/apps/${appId}/public-keys/public`,
           "POST",
           { "X-Public-Key": secretKey },
           JSON.stringify({})
@@ -1152,7 +1143,7 @@ ${colors.blue}?${colors.reset} \uC571 \uC120\uD0DD (\uBC88\uD638): `);
   return createData.app_id;
 }
 async function startTunnel(port, config, tunnelOpts) {
-  let tunnelKey = config.secretKey || (config.apiKey?.startsWith("cb_sk_") ? config.apiKey : "");
+  let tunnelKey = config.secretKey || (config.publicKey?.startsWith("cb_sk_") ? config.publicKey : "");
   if (!tunnelKey) {
     info("Secret Key\uAC00 \uC5C6\uC2B5\uB2C8\uB2E4. \uBE0C\uB77C\uC6B0\uC800 \uB85C\uADF8\uC778\uC73C\uB85C \uBC1C\uAE09\uD569\uB2C8\uB2E4...");
     try {
@@ -1253,7 +1244,7 @@ ${colors.cyan}ConnectBase Tunnel${colors.reset}`);
         "Connection": "Upgrade",
         "Sec-WebSocket-Key": wsKey,
         "Sec-WebSocket-Version": "13",
-        "Authorization": `Bearer ${config.secretKey ?? config.apiKey}`
+        "Authorization": `Bearer ${config.secretKey ?? config.publicKey}`
       }
     };
     const req = lib.request(reqOptions);
@@ -1498,7 +1489,7 @@ ${colors.yellow}\uCF54\uB4DC \uBD84\uC11D (MCP \uD1B5\uD574 \uC0AC\uC6A9):${colo
 
 ${colors.yellow}\uC635\uC158:${colors.reset}
   -s, --storage <id>    \uC2A4\uD1A0\uB9AC\uC9C0 ID
-  -k, --api-key <key>   API Key
+  -k, --public-key <key>   API Key
   -u, --base-url <url>  \uC11C\uBC84 URL (\uAE30\uBCF8: ${DEFAULT_BASE_URL})
   -t, --timeout <sec>   \uD130\uB110 \uC694\uCCAD \uD0C0\uC784\uC544\uC6C3 (\uCD08, tunnel \uC804\uC6A9)
   --max-body <MB>       \uD130\uB110 \uCD5C\uB300 \uBC14\uB514 \uD06C\uAE30 (MB, tunnel \uC804\uC6A9)
@@ -1532,7 +1523,7 @@ ${colors.yellow}\uBE60\uB978 \uC2DC\uC791:${colors.reset}
 ${colors.yellow}\uD658\uACBD\uBCC0\uC218:${colors.reset}
   CONNECTBASE_PUBLIC_KEY    Public Key (cb_pk_*)
   CONNECTBASE_SECRET_KEY    Secret Key (cb_sk_*, \uD130\uB110\uC6A9)
-  CONNECTBASE_API_KEY       (deprecated) \uB808\uAC70\uC2DC \u2014 publicKey \uB610\uB294 secretKey \uB85C \uC0AC\uC6A9
+  CONNECTBASE_PUBLIC_KEY       (deprecated) \uB808\uAC70\uC2DC \u2014 publicKey \uB610\uB294 secretKey \uB85C \uC0AC\uC6A9
   CONNECTBASE_STORAGE_ID    \uC2A4\uD1A0\uB9AC\uC9C0 ID
   CONNECTBASE_BASE_URL      \uC11C\uBC84 URL
 
@@ -1555,7 +1546,7 @@ function parseArgs(args) {
     const arg = args[i];
     if (arg === "-s" || arg === "--storage") {
       result.options.storageId = args[++i];
-    } else if (arg === "-k" || arg === "--public-key" || arg === "--api-key") {
+    } else if (arg === "-k" || arg === "--public-key" || arg === "--public-key") {
       result.options.publicKey = args[++i];
     } else if (arg === "--secret-key") {
       result.options.secretKey = args[++i];
@@ -1598,14 +1589,13 @@ async function main() {
   const config = {
     publicKey: parsed.options.publicKey || fileConfig.publicKey,
     secretKey: parsed.options.secretKey || fileConfig.secretKey,
-    apiKey: fileConfig.apiKey,
     storageId: parsed.options.storageId || fileConfig.storageId,
     baseUrl: parsed.options.baseUrl || fileConfig.baseUrl || DEFAULT_BASE_URL
   };
   if (parsed.command === "init") {
     await init();
   } else if (parsed.command === "docs") {
-    let docsPublicKey = config.publicKey ?? config.apiKey;
+    let docsPublicKey = config.publicKey ?? config.publicKey;
     if (!docsPublicKey) {
       docsPublicKey = await prompt(`${colors.blue}?${colors.reset} Public Key: `);
       if (!docsPublicKey) {
@@ -1618,7 +1608,7 @@ async function main() {
     await setupMcp();
   } else if (parsed.command === "deploy") {
     const directory = parsed.args[0] || fileConfig.deployDir || ".";
-    if (!config.publicKey && !config.apiKey) {
+    if (!config.publicKey && !config.publicKey) {
       error('Public Key\uAC00 \uD544\uC694\uD569\uB2C8\uB2E4. "npx connectbase-client init"\uC73C\uB85C \uC124\uC815\uD558\uAC70\uB098 -k \uC635\uC158\uC744 \uC0AC\uC6A9\uD558\uC138\uC694');
       process.exit(1);
     }