connectbase-client 0.1.4 → 0.1.6

package/README.md

@@ -57,77 +57,87 @@ const state = await gameClient.createRoom({
 
 Deploy your web application to Connect Base Web Storage with a single command.
 
-### Basic Usage
+### Quick Start
 
 ```bash
-# Deploy a directory
-npx connectbase-client deploy ./dist -s <storage-id> -k <api-key>
+# 1. Initialize (one-time setup)
+npx connectbase-client init
+
+# 2. Deploy
+npm run deploy
+```
+
+The `init` command will:
+- Ask for your API Key and Storage ID
+- Create a `.connectbaserc` config file
+- Add `.connectbaserc` to `.gitignore`
+- Add a `deploy` script to `package.json`
 
-# Deploy current directory
-npx connectbase-client deploy . -s <storage-id> -k <api-key>
+### Commands
+
+| Command | Description |
+|---------|-------------|
+| `init` | Interactive project setup (creates config, adds deploy script) |
+| `deploy <dir>` | Deploy files to web storage |
+
+### Manual Usage
+
+If you prefer not to use `init`, you can pass options directly:
+
+```bash
+npx connectbase-client deploy ./dist -s <storage-id> -k <api-key>
 ```
 
 ### Options
 
 | Option | Alias | Description |
 |--------|-------|-------------|
-| `--storage <id>` | `-s` | Storage ID (required) |
-| `--api-key <key>` | `-k` | API Key (required) |
+| `--storage <id>` | `-s` | Storage ID |
+| `--api-key <key>` | `-k` | API Key |
 | `--base-url <url>` | `-u` | Custom server URL |
 | `--help` | `-h` | Show help |
 | `--version` | `-v` | Show version |
 
-### Environment Variables
-
-You can set credentials via environment variables:
-
-```bash
-export CONNECTBASE_API_KEY=your-api-key
-export CONNECTBASE_STORAGE_ID=your-storage-id
-
-# Then deploy without options
-npx connectbase-client deploy ./dist
-```
-
 ### Configuration File
 
-Create a `.connectbaserc` file in your project root:
+The `init` command creates `.connectbaserc` automatically. You can also create it manually:
 
 ```json
 {
   "apiKey": "your-api-key",
-  "storageId": "your-storage-id"
+  "storageId": "your-storage-id",
+  "deployDir": "./dist"
 }
 ```
 
-Then deploy:
+### Environment Variables
 
 ```bash
+export CONNECTBASE_API_KEY=your-api-key
+export CONNECTBASE_STORAGE_ID=your-storage-id
 npx connectbase-client deploy ./dist
 ```
 
-### npm Scripts
+### Requirements
 
-Add to your `package.json`:
+- `index.html` must exist in the root of the deploy directory
+- Supported file types: `.html`, `.css`, `.js`, `.json`, `.svg`, `.png`, `.jpg`, `.gif`, `.webp`, `.woff`, `.woff2`, `.ttf`, `.mp3`, `.mp4`, `.pdf`, `.wasm`, etc.
 
-```json
-{
-  "scripts": {
-    "deploy": "connectbase-client deploy ./dist"
-  }
-}
-```
+### SPA Mode
+
+Web Storage supports SPA (Single Page Application) mode, which is **enabled by default**. When enabled, requests to non-existent paths return `index.html` instead of 404, allowing client-side routers (React Router, Vue Router, etc.) to handle routing.
 
-Then run:
+You can toggle SPA mode in the Connect Base Console under **Storage > Security Settings**, or via the API:
 
 ```bash
-npm run deploy
+# Disable SPA mode (for static sites)
+curl -X PUT "https://api.connectbase.world/v1/apps/{appID}/storages/webs/{storageID}" \
+  -H "Authorization: Bearer <TOKEN>" \
+  -H "Content-Type: application/json" \
+  -d '{"spa_mode": false}'
 ```
 
-### Requirements
-
-- `index.html` must exist in the root of the deploy directory
-- Supported file types: `.html`, `.css`, `.js`, `.json`, `.svg`, `.png`, `.jpg`, `.gif`, `.webp`, `.woff`, `.woff2`, `.ttf`, `.mp3`, `.mp4`, `.pdf`, `.wasm`, etc.
+> **Important:** When using SPA mode, ensure all asset paths in your HTML are absolute (`/assets/...`), not relative (`./assets/...`). For Vite projects, set `base: '/'` in `vite.config.ts`.
 
 ## API Reference
 
@@ -339,9 +349,11 @@ const session = await cb.auth.signIn({
   password: 'password123'
 })
 
-// OAuth login
-const oauthUrl = await cb.oauth.getGoogleAuthUrl()
-// Redirect user to oauthUrl
+// OAuth login (리다이렉트 방식)
+await cb.oauth.signIn('google', 'https://myapp.com/oauth/callback')
+
+// OAuth login (팝업 방식)
+const result = await cb.oauth.signInWithPopup('google', 'https://myapp.com/oauth/popup-callback')
 
 // Get current user
 const user = await cb.auth.getCurrentUser()

package/dist/cli.js

@@ -29,6 +29,7 @@ var fs = __toESM(require("fs"));
 var path = __toESM(require("path"));
 var https = __toESM(require("https"));
 var http = __toESM(require("http"));
+var readline = __toESM(require("readline"));
 var VERSION = "0.1.3";
 var DEFAULT_BASE_URL = "https://api.connectbase.world";
 var colors = {
@@ -123,6 +124,7 @@ function loadConfig() {
       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;
     } catch {
       warn(".connectbaserc \uD30C\uC77C\uC744 \uC77D\uC744 \uC218 \uC5C6\uC2B5\uB2C8\uB2E4");
     }
@@ -257,6 +259,107 @@ ${colors.cyan}URL: ${data.url}${colors.reset}
     process.exit(1);
   }
 }
+function prompt(question) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout
+  });
+  return new Promise((resolve2) => {
+    rl.question(question, (answer) => {
+      rl.close();
+      resolve2(answer.trim());
+    });
+  });
+}
+async function init() {
+  log(`
+${colors.cyan}Connect Base \uD504\uB85C\uC81D\uD2B8 \uCD08\uAE30\uD654${colors.reset}
+`);
+  const rcPath = path.join(process.cwd(), ".connectbaserc");
+  if (fs.existsSync(rcPath)) {
+    const overwrite = await prompt(`${colors.yellow}\u26A0${colors.reset} .connectbaserc\uAC00 \uC774\uBBF8 \uC874\uC7AC\uD569\uB2C8\uB2E4. \uB36E\uC5B4\uC4F0\uC2DC\uACA0\uC2B5\uB2C8\uAE4C? (y/N): `);
+    if (overwrite.toLowerCase() !== "y") {
+      info("\uCD08\uAE30\uD654\uAC00 \uCDE8\uC18C\uB418\uC5C8\uC2B5\uB2C8\uB2E4");
+      return;
+    }
+  }
+  const apiKey = await prompt(`${colors.blue}?${colors.reset} API Key: `);
+  if (!apiKey) {
+    error("API Key\uB294 \uD544\uC218\uC785\uB2C8\uB2E4");
+    process.exit(1);
+  }
+  const storageId = await prompt(`${colors.blue}?${colors.reset} Storage ID: `);
+  if (!storageId) {
+    error("Storage ID\uB294 \uD544\uC218\uC785\uB2C8\uB2E4");
+    process.exit(1);
+  }
+  const defaultDir = detectBuildDir();
+  const deployDir = await prompt(`${colors.blue}?${colors.reset} \uBC30\uD3EC \uB514\uB809\uD1A0\uB9AC (${defaultDir}): `) || defaultDir;
+  const config = {
+    apiKey,
+    storageId,
+    deployDir
+  };
+  fs.writeFileSync(rcPath, JSON.stringify(config, null, 2) + "\n");
+  success(".connectbaserc \uC0DD\uC131 \uC644\uB8CC");
+  addToGitignore(".connectbaserc");
+  addDeployScript(deployDir);
+  log(`
+${colors.green}\uCD08\uAE30\uD654 \uC644\uB8CC!${colors.reset}
+`);
+  log(`${colors.dim}\uBC30\uD3EC\uD558\uB824\uBA74:${colors.reset}`);
+  log(`  ${colors.cyan}npm run deploy${colors.reset}
+`);
+}
+function detectBuildDir() {
+  if (fs.existsSync(path.join(process.cwd(), "dist"))) return "./dist";
+  if (fs.existsSync(path.join(process.cwd(), "build"))) return "./build";
+  if (fs.existsSync(path.join(process.cwd(), "out"))) return "./out";
+  if (fs.existsSync(path.join(process.cwd(), ".next"))) return "./out";
+  if (fs.existsSync(path.join(process.cwd(), "vite.config.ts")) || fs.existsSync(path.join(process.cwd(), "vite.config.js"))) return "./dist";
+  if (fs.existsSync(path.join(process.cwd(), "next.config.js")) || fs.existsSync(path.join(process.cwd(), "next.config.mjs"))) return "./out";
+  return "./dist";
+}
+function addToGitignore(entry) {
+  const gitignorePath = path.join(process.cwd(), ".gitignore");
+  if (fs.existsSync(gitignorePath)) {
+    const content = fs.readFileSync(gitignorePath, "utf-8");
+    if (!content.includes(entry)) {
+      fs.appendFileSync(gitignorePath, `
+# Connect Base
+${entry}
+`);
+      success(`.gitignore\uC5D0 ${entry} \uCD94\uAC00 \uC644\uB8CC`);
+    } else {
+      info(`.gitignore\uC5D0 \uC774\uBBF8 ${entry}\uAC00 \uD3EC\uD568\uB418\uC5B4 \uC788\uC2B5\uB2C8\uB2E4`);
+    }
+  } else {
+    fs.writeFileSync(gitignorePath, `# Connect Base
+${entry}
+`);
+    success(".gitignore \uC0DD\uC131 \uC644\uB8CC");
+  }
+}
+function addDeployScript(deployDir) {
+  const pkgPath = path.join(process.cwd(), "package.json");
+  if (!fs.existsSync(pkgPath)) {
+    warn("package.json\uC744 \uCC3E\uC744 \uC218 \uC5C6\uC5B4 deploy \uC2A4\uD06C\uB9BD\uD2B8\uB97C \uCD94\uAC00\uD558\uC9C0 \uC54A\uC558\uC2B5\uB2C8\uB2E4");
+    return;
+  }
+  try {
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+    if (!pkg.scripts) pkg.scripts = {};
+    if (pkg.scripts.deploy) {
+      info(`package.json\uC5D0 \uC774\uBBF8 deploy \uC2A4\uD06C\uB9BD\uD2B8\uAC00 \uC788\uC2B5\uB2C8\uB2E4: "${pkg.scripts.deploy}"`);
+      return;
+    }
+    pkg.scripts.deploy = `connectbase-client deploy ${deployDir}`;
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
+    success(`package.json\uC5D0 deploy \uC2A4\uD06C\uB9BD\uD2B8 \uCD94\uAC00 \uC644\uB8CC`);
+  } catch {
+    warn("package.json \uC218\uC815\uC5D0 \uC2E4\uD328\uD588\uC2B5\uB2C8\uB2E4");
+  }
+}
 function showHelp() {
   log(`
 ${colors.cyan}connectbase-client${colors.reset} - Connect Base SDK & CLI
@@ -265,6 +368,7 @@ ${colors.yellow}\uC0AC\uC6A9\uBC95:${colors.reset}
   npx connectbase-client <command> [options]
 
 ${colors.yellow}\uBA85\uB839\uC5B4:${colors.reset}
+  init                  \uD504\uB85C\uC81D\uD2B8 \uCD08\uAE30\uD654 (\uC124\uC815 \uD30C\uC77C \uC0DD\uC131)
   deploy <directory>    \uC6F9 \uC2A4\uD1A0\uB9AC\uC9C0\uC5D0 \uD30C\uC77C \uBC30\uD3EC
 
 ${colors.yellow}\uC635\uC158:${colors.reset}
@@ -274,6 +378,13 @@ ${colors.yellow}\uC635\uC158:${colors.reset}
   -h, --help            \uB3C4\uC6C0\uB9D0 \uD45C\uC2DC
   -v, --version         \uBC84\uC804 \uD45C\uC2DC
 
+${colors.yellow}\uBE60\uB978 \uC2DC\uC791:${colors.reset}
+  ${colors.dim}# 1. \uCD08\uAE30\uD654 (\uCD5C\uCD08 1\uD68C)${colors.reset}
+  npx connectbase-client init
+
+  ${colors.dim}# 2. \uBC30\uD3EC${colors.reset}
+  npm run deploy
+
 ${colors.yellow}\uD658\uACBD\uBCC0\uC218:${colors.reset}
   CONNECTBASE_API_KEY       API Key
   CONNECTBASE_STORAGE_ID    \uC2A4\uD1A0\uB9AC\uC9C0 ID
@@ -282,21 +393,8 @@ ${colors.yellow}\uD658\uACBD\uBCC0\uC218:${colors.reset}
 ${colors.yellow}\uC124\uC815 \uD30C\uC77C (.connectbaserc):${colors.reset}
   {
     "apiKey": "your-api-key",
-    "storageId": "your-storage-id"
-  }
-
-${colors.yellow}\uC608\uC2DC:${colors.reset}
-  ${colors.dim}# \uAE30\uBCF8 \uBC30\uD3EC${colors.reset}
-  npx connectbase-client deploy ./dist -s <storage-id> -k <api-key>
-
-  ${colors.dim}# \uD658\uACBD\uBCC0\uC218 \uC0AC\uC6A9${colors.reset}
-  export CONNECTBASE_API_KEY=your-api-key
-  export CONNECTBASE_STORAGE_ID=your-storage-id
-  npx connectbase-client deploy ./dist
-
-  ${colors.dim}# package.json scripts\uC5D0\uC11C \uC0AC\uC6A9${colors.reset}
-  "scripts": {
-    "deploy": "connectbase-client deploy ./dist"
+    "storageId": "your-storage-id",
+    "deployDir": "./dist"
   }
 `);
 }
@@ -345,14 +443,16 @@ async function main() {
     storageId: parsed.options.storageId || fileConfig.storageId,
     baseUrl: parsed.options.baseUrl || fileConfig.baseUrl || DEFAULT_BASE_URL
   };
-  if (parsed.command === "deploy") {
-    const directory = parsed.args[0] || ".";
+  if (parsed.command === "init") {
+    await init();
+  } else if (parsed.command === "deploy") {
+    const directory = parsed.args[0] || fileConfig.deployDir || ".";
     if (!config.apiKey) {
-      error("API Key\uAC00 \uD544\uC694\uD569\uB2C8\uB2E4 (-k \uC635\uC158 \uB610\uB294 CONNECTBASE_API_KEY \uD658\uACBD\uBCC0\uC218)");
+      error('API 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);
     }
     if (!config.storageId) {
-      error("\uC2A4\uD1A0\uB9AC\uC9C0 ID\uAC00 \uD544\uC694\uD569\uB2C8\uB2E4 (-s \uC635\uC158 \uB610\uB294 CONNECTBASE_STORAGE_ID \uD658\uACBD\uBCC0\uC218)");
+      error('\uC2A4\uD1A0\uB9AC\uC9C0 ID\uAC00 \uD544\uC694\uD569\uB2C8\uB2E4. "npx connectbase-client init"\uC73C\uB85C \uC124\uC815\uD558\uAC70\uB098 -s \uC635\uC158\uC744 \uC0AC\uC6A9\uD558\uC138\uC694');
       process.exit(1);
     }
     await deploy(directory, config);