spck 0.3.1

package/src/i18n/index.ts

@@ -0,0 +1,119 @@
+/**
+ * Lightweight i18n system for the CLI
+ * No external dependencies — uses JSON locale files with dot-path keys and {{variable}} interpolation
+ */
+
+import { readFileSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import osLocale from 'os-locale';
+
+type Translations = Record<string, any>;
+
+// Support both CJS (ts-jest) and ESM (runtime) contexts
+// eslint-disable-next-line no-eval
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const localesDir = join(__dirname, 'locales');
+
+function loadLocale(file: string): Translations {
+  try {
+    return JSON.parse(readFileSync(join(localesDir, file), 'utf-8'));
+  } catch {
+    return {};
+  }
+}
+
+const en = loadLocale('en.json');
+
+const locales: Record<string, Translations> = {
+  en,
+  es: loadLocale('es.json'),
+  fr: loadLocale('fr.json'),
+  id: loadLocale('id.json'),
+  ja: loadLocale('ja.json'),
+  ko: loadLocale('ko.json'),
+  pt: loadLocale('pt.json'),
+  'zh-Hans': loadLocale('zh-Hans.json'),
+};
+
+const SUPPORTED_LOCALES = Object.keys(locales);
+
+let currentLocale = 'en';
+
+/**
+ * Map system locale string (e.g. "ja_JP.UTF-8") to a supported locale code
+ */
+function mapLocale(raw: string): string {
+  // Normalize: lowercase, replace - with _
+  const normalized = raw.toLowerCase().replace(/-/g, '_');
+
+  // zh_cn / zh_sg → zh-Hans
+  if (normalized.startsWith('zh_cn') || normalized.startsWith('zh_sg') || normalized === 'zh_hans' || normalized.startsWith('zh_hans')) {
+    return 'zh-Hans';
+  }
+
+  // Extract language code (before _ or .)
+  const lang = normalized.split(/[_.]/)[0];
+
+  if (SUPPORTED_LOCALES.includes(lang)) {
+    return lang;
+  }
+
+  return 'en';
+}
+
+/**
+ * Detect locale using os-locale (reads LC_ALL, LANG, LANGUAGE, and OS-specific APIs)
+ */
+export function detectLocale(): string {
+  const raw = osLocale();
+  currentLocale = mapLocale(raw);
+  return currentLocale;
+}
+
+/**
+ * Set locale explicitly (e.g. from --locale CLI flag)
+ */
+export function setLocale(locale: string): void {
+  currentLocale = mapLocale(locale);
+}
+
+/**
+ * Get the current locale
+ */
+export function getLocale(): string {
+  return currentLocale;
+}
+
+/**
+ * Resolve a dot-path key from a translations object
+ * e.g. resolve('tools.gitDetected', translations) → translations.tools.gitDetected
+ */
+function resolve(key: string, obj: Translations): string | undefined {
+  const parts = key.split('.');
+  let current: any = obj;
+  for (const part of parts) {
+    if (current == null || typeof current !== 'object') return undefined;
+    current = current[part];
+  }
+  return typeof current === 'string' ? current : undefined;
+}
+
+/**
+ * Translate a key with optional parameter interpolation
+ *
+ * @param key - Dot-path key (e.g. 'tools.gitDetected')
+ * @param params - Optional parameters for {{variable}} interpolation
+ * @returns Translated string, falling back to English, then the key itself
+ */
+export function t(key: string, params?: Record<string, string | number>): string {
+  let text = resolve(key, locales[currentLocale]) ?? resolve(key, en) ?? key;
+
+  if (params) {
+    for (const [name, value] of Object.entries(params)) {
+      text = text.replace(new RegExp(`\\{\\{${name}\\}\\}`, 'g'), String(value));
+    }
+  }
+
+  return text;
+}

package/src/i18n/locales/en.json

@@ -0,0 +1,313 @@
+{
+  "app": {
+    "title": "Spck CLI",
+    "goodbye": "Goodbye!"
+  },
+  "config": {
+    "loaded": "Configuration loaded",
+    "notFound": "No configuration found. Running setup wizard...",
+    "corrupted": "Configuration file is corrupted",
+    "corruptedRunSetup": "Running setup wizard to recreate...",
+    "fileNotFound": "Configuration file not found: {{path}}",
+    "fileNotFoundHint": "Running setup wizard to create initial configuration...",
+    "fileCorrupted": "Configuration file is corrupted: {{path}}",
+    "fileCorruptedHint": "Will run setup wizard to recreate...",
+    "saved": "Configuration saved successfully!"
+  },
+  "auth": {
+    "title": "Firebase Authentication",
+    "startingCallback": "Starting local callback server on port {{port}}...",
+    "openingBrowser": "Opening browser for authentication...",
+    "couldNotOpenBrowser": "Could not open browser automatically: {{message}}",
+    "manualAuthHint": "If browser doesn't open, authenticate manually:",
+    "visitUrl": "Or visit: {{url}}",
+    "waiting": "Waiting for authentication (timeout: 10 minutes)...",
+    "success": "Authentication successful!",
+    "userId": "User ID: {{userId}}",
+    "credentialsLoaded": "Firebase credentials loaded",
+    "generatingToken": "Generating fresh Firebase ID token...",
+    "noRefreshToken": "No refresh token available. Re-authentication required.",
+    "refreshTokenExpired": "Refresh token expired or invalid. Re-authentication required.",
+    "tokenRefreshError": "Token refresh error: {{message}}",
+    "tokenRefreshFailed": "Token refresh failed. Re-authentication required."
+  },
+  "tools": {
+    "title": "Tool Detection",
+    "gitForceDisabled": "Git force-disabled (development mode)",
+    "gitDetected": "Git detected: {{version}}",
+    "gitDetectedShort": "Git detected",
+    "gitNotDetected": "Git not detected",
+    "gitDisabledHint": "Git features will be disabled in this session.",
+    "gitInstallHint": "Install Git to enable version control features:",
+    "ripgrepForceDisabled": "Ripgrep force-disabled (development mode)",
+    "ripgrepDetected": "Ripgrep detected: {{version}}",
+    "ripgrepDetectedShort": "Ripgrep detected",
+    "ripgrepNotDetected": "Ripgrep not detected",
+    "ripgrepDisabledHint": "Fast search features will be disabled in this session.",
+    "ripgrepInstallHint": "Install ripgrep for high-performance code search:",
+    "gitInstallUrl": "https://git-scm.com/downloads",
+    "ripgrepInstallUrl": "https://github.com/BurntSushi/ripgrep#installation"
+  },
+  "features": {
+    "title": "Available Features",
+    "filesystem": "Filesystem operations",
+    "gitEnabled": "Git version control",
+    "gitDisabled": "Git version control (git not installed)",
+    "searchFast": "Fast search (ripgrep)",
+    "searchBasic": "Basic search (ripgrep not installed)",
+    "terminalEnabled": "Terminal service",
+    "terminalDisabled": "Terminal service (disabled in config)",
+    "browserProxyEnabled": "Browser proxy service",
+    "browserProxyDisabled": "Browser proxy service (disabled in config)",
+    "securityTitle": "Security Mode",
+    "userAuthEnabled": "User Authentication: ENABLED",
+    "userAuthEnabledHint1": "Requires Firebase authentication for all connections",
+    "userAuthEnabledHint2": "Adds user identity verification layer",
+    "userAuthEnabledHint3": "Compatible with Spck Editor (not Lite)",
+    "userAuthDisabled": "User Authentication: DISABLED",
+    "userAuthDisabledHint1": "Connections protected by secret signing key only",
+    "userAuthDisabledHint2": "Lower latency, no Firebase auth required",
+    "userAuthDisabledHint3": "Compatible with Spck Editor Lite"
+  },
+  "server": {
+    "selectingBest": "Selecting best relay server...",
+    "checkingLatency": "Checking server latency...",
+    "selected": "Selected server: {{label}} ({{url}}) - {{ping}}ms",
+    "allUnreachable": "All servers unreachable, using default: {{url}}",
+    "usingOverride": "Using server override: {{url}}",
+    "usingSaved": "Using saved server: {{url}}",
+    "failedSelect": "Failed to select relay server: {{message}}",
+    "usingDefault": "Using default: {{url}}",
+    "unreachable": "unreachable"
+  },
+  "connection": {
+    "title": "Connecting to Relay Server",
+    "relayServer": "Relay server: {{server}}",
+    "scanQR": "Scan this QR code with Spck Editor mobile app:",
+    "clientId": "Client ID: {{id}}",
+    "secret": "Secret: {{secret}}",
+    "name": "Name: {{name}}",
+    "relayServerLabel": "Relay server: {{server}}",
+    "relayServerMismatch": "IMPORTANT: The client must select the same relay server",
+    "relayServerMismatchHint": "({{server}}) in Spck Editor to connect.",
+    "existingFound": "Existing connection found",
+    "connectedAt": "Connected at: {{date}}",
+    "noExisting": "No existing connection found. Connecting to proxy...",
+    "tokenExpired": "Server token expired. Reconnecting...",
+    "settingsCorrupted": "Connection settings corrupted, will reconnect to proxy...",
+    "reusingSecret": "Reusing existing secret for clientId",
+    "generatedSecret": "Generated new secret for clientId",
+    "newDevice": "New device connecting: {{deviceId}}",
+    "newDeviceWarning": "This is the first time this device has connected.",
+    "newDeviceCompromised": "If you did not initiate this connection, your credentials may be compromised.",
+    "userVerifying": "Requesting user verification...",
+    "userVerified": "User verified for {{deviceId}}: {{userId}}",
+    "userVerifyFailed": "User verification failed for {{deviceId}}: {{message}}",
+    "userVerifyOptional": "Continuing anyway (verification is optional)",
+    "protocolNegotiated": "Protocol v{{version}} negotiated with {{deviceId}}",
+    "protocolUnsupported": "Unsupported protocol version {{version}} from {{deviceId}}. This CLI only supports protocol v1. An upgrade is required: update your client/library (and this CLI, if applicable) to the latest version so protocol versions match. If you installed the CLI globally, run: npm i -g spck@latest",
+    "chunkingMessage": "Chunking large {{event}} message: {{chunks}} chunks (~{{size}}MB) for {{deviceId}}",
+    "disconnectedFromProxy": "Disconnected from proxy: {{reason}}",
+    "serverTerminated": "Server terminated connection. Exiting...",
+    "attemptingReconnect": "Attempting to reconnect...",
+    "reconnectAttempt": "Reconnection attempt {{attempt}}/5...",
+    "reconnected": "Reconnected after {{attempts}} attempts",
+    "reconnectFailed": "Failed to reconnect after 5 attempts.",
+    "exiting": "Exiting...",
+    "shuttingDown": "Shutting down gracefully...",
+    "killTimeout": "Kill acknowledgment timeout, forcing disconnect",
+    "gracefulDisconnect": "Gracefully disconnected from proxy",
+    "connectError": "Connection error: {{message}}",
+    "connectErrorNamespace": "Namespace: /listen",
+    "connectErrorType": "Error type: {{type}}",
+    "connectFailed": "Failed to connect to relay server",
+    "connectFailedUrl": "URL: {{url}}/listen",
+    "connectFailedError": "Error: {{message}}",
+    "connectFailedCauses": "Possible causes:",
+    "connectFailedCause1": "- Server is not reachable (check your internet connection)",
+    "connectFailedCause2": "- Network/firewall blocking connection",
+    "unknownMessageType": "Unknown message type from {{deviceId}}",
+    "errorHandlingMessage": "Error handling message from {{deviceId}}",
+    "unknownHandshakeType": "Unknown handshake message type: {{type}}",
+    "rejectingUnauthenticated": "Rejecting {{event}} from unauthenticated connection: {{deviceId}}",
+    "rejectingUserVerification": "Rejecting protocol_selected - user verification required but not completed: {{deviceId}}",
+    "invalidRpcMessage": "Invalid RPC message from {{deviceId}}",
+    "unhandledError": "Unhandled error in handleError:",
+    "freeTierNotice": "Free account: {{used}} / {{limit}} min used today ({{remaining}} min remaining)",
+    "freeTierUpgrade": "Upgrade for unlimited CLI access."
+  },
+  "multipleConnection": {
+    "detected": "MULTIPLE CONNECTION ATTEMPT DETECTED!",
+    "existingCount": "Existing connections: {{count}}",
+    "newConnectionId": "New connection ID: {{id}}",
+    "rejectedHint": "For security reasons, new connections are rejected by default.",
+    "restartHint": "If you want to allow multiple connections, restart the CLI.",
+    "compromiseWarning": "If you did not initiate this connection, your client ID",
+    "compromiseHint": "may have been compromised. Consider regenerating it."
+  },
+  "proxyError": {
+    "error": "Proxy error: {{message}}",
+    "tokenExpiredTimeout": "Your access token has expired or timed out.",
+    "tokenExpiredHint": "Please try again or re-authenticate with: spck auth login",
+    "tokenRevoked": "Your login token has been revoked.",
+    "tokenRevokedHint": "Please re-authenticate: spck auth logout && spck auth login",
+    "privacyConsent": "Privacy policy consent required.",
+    "privacyConsentHint1": "Please accept the privacy policy in the Spck Editor app",
+    "privacyConsentHint2": "under Account Settings to use this feature.",
+    "accountDeleting": "Your account is being deleted.",
+    "accountDeletingHint": "Please wait 72 hours before trying again.",
+    "accountBanned": "This account has been banned.",
+    "accountBannedHint1": "Your account has been banned for violation of the",
+    "accountBannedHint2": "Terms of Service agreement.",
+    "subscriptionCheckFailed": "Unable to verify subscription status.",
+    "subscriptionCheckFailedHint": "This may be a temporary issue. Please try again later.",
+    "subscriptionRequired": "This feature requires a paid subscription.",
+    "subscriptionRequiredHint": "Open the Spck Editor app to upgrade to Supporter or Gold.",
+    "maxConnections": "Maximum of {{max}} CLI connections reached.",
+    "maxConnectionsHint": "Close other CLI instances and try again.",
+    "duplicateClientId": "A CLI with this client ID is already connected.",
+    "duplicateHint1": "This can happen if:",
+    "duplicateHint2": "- Another CLI instance is still running with the same connection",
+    "duplicateHint3": "- A previous connection did not properly disconnect",
+    "duplicateHint4": "Please:",
+    "duplicateHint5": "1. Close any other running CLI instances",
+    "duplicateHint6": "2. Wait a few seconds for the previous connection to timeout",
+    "duplicateHint7": "3. Try connecting again",
+    "firebaseExpiredRefreshFailed": "Firebase token expired and refresh failed.",
+    "firebaseExpiredRefreshFailedHint": "Please re-authenticate: spck auth login",
+    "firebaseExpired": "Firebase token expired.",
+    "firebaseExpiredHint": "Please re-authenticate: spck auth login",
+    "firebaseInvalid": "Firebase token is invalid (not expired).",
+    "firebaseInvalidHint1": "The token may be corrupted or from a different account.",
+    "firebaseInvalidHint2": "Please re-authenticate: spck auth login",
+    "firebaseTokenExpiring": "Firebase token expired. Attempting to refresh...",
+    "tokenRefreshFailed": "Token refresh failed: {{message}}",
+    "dailyLimitExceeded": "Daily free tier limit of 30 minutes has been reached.",
+    "dailyLimitReset": "Limit resets in {{time}}.",
+    "dailyLimitExceededHint": "Open the Spck Editor app to upgrade to Supporter or Gold for unlimited CLI access.",
+    "defaultError": "A problem occurred when verifying your subscription."
+  },
+  "errors": {
+    "permissionError": "Permission Error: Cannot write to required directory",
+    "permissionPath": "Path: {{path}}",
+    "permissionOperation": "Operation: {{operation}}",
+    "permissionFix": "Please fix permissions:",
+    "permissionFixCmd1": "chmod 700 ~/.spck-editor",
+    "permissionFixCmd2": "chmod 600 ~/.spck-editor/.credentials.json",
+    "permissionFixHint": "Or ensure your user has write access to the home directory.",
+    "diskFull": "Disk Full: No space left on device",
+    "diskFullHint": "Please free up disk space and try again.",
+    "cannotConnect": "Cannot connect to proxy server",
+    "cannotConnectError": "Error: {{message}}",
+    "cannotConnectCauses": "Possible causes:",
+    "cannotConnectCause1": "- Proxy server is down",
+    "cannotConnectCause2": "- Network connection issue",
+    "cannotConnectCause3": "- Incorrect proxy URL in config",
+    "cannotConnectHint": "Please check the proxy URL and try again.",
+    "failedToStart": "Failed to start proxy client: {{message}}",
+    "rootNotFound": "Root directory not found: {{path}}",
+    "rootNotFoundHint": "Please ensure the directory exists and is accessible, or run setup wizard:",
+    "rootNotFoundCmd": "spck --setup",
+    "uncaughtException": "Uncaught exception: {{message}}",
+    "unhandledRejection": "Unhandled rejection: {{message}}",
+    "shutdownError": "Error during shutdown: {{message}}",
+    "cliError": "Error: {{message}}",
+    "cliErrorHint": "Run with --help to see available commands and options."
+  },
+  "logout": {
+    "title": "Logout",
+    "clearedCredentials": "Cleared user credentials",
+    "removed": "Removed: {{path}}",
+    "clearedSettings": "Cleared connection settings",
+    "noCredentials": "No credentials or connection settings found",
+    "notLoggedIn": "You are not currently logged in.",
+    "success": "Successfully logged out!",
+    "runAgain": "Run the CLI again to re-authenticate."
+  },
+  "account": {
+    "title": "Account Information",
+    "credentialsCorrupted": "Credentials file is corrupted.",
+    "credentialsCorruptedHint1": "Please logout and re-authenticate:",
+    "credentialsCorruptedHint2": "spck --logout",
+    "notLoggedIn": "Not currently logged in.",
+    "notLoggedInHint1": "Run the CLI to authenticate:",
+    "notLoggedInHint2": "spck",
+    "fetching": "Fetching account information...",
+    "decodeFailed": "Failed to decode authentication token",
+    "loggedIn": "Logged In",
+    "userId": "User ID:  {{userId}}",
+    "email": "Email:    {{email}}",
+    "verified": "Verified: {{status}}",
+    "yes": "Yes",
+    "no": "No",
+    "tokenExpires": "Token expires: {{date}}",
+    "timeRemaining": "Time remaining: {{hours}}h {{minutes}}m",
+    "subscription": "Subscription",
+    "status": "Status: {{status}}",
+    "plan": "Plan: {{plan}}",
+    "premium": "Premium: {{status}}",
+    "fetchFailed": "Failed to retrieve account information",
+    "fetchFailedError": "Error: {{message}}",
+    "permissionDenied": "Permission denied accessing credentials file",
+    "permissionHint1": "Please check file permissions:",
+    "permissionHint2": "chmod 600 ~/.spck-editor/.credentials.json",
+    "networkError": "Network connection error",
+    "networkHint": "Please check your internet connection"
+  },
+  "credentials": {
+    "corrupted": "Credentials file is corrupted: {{path}}",
+    "corruptedHint": "Will trigger re-authentication...",
+    "settingsCorrupted": "Connection settings file is corrupted: {{path}}",
+    "settingsCorruptedHint": "Will reconnect to proxy..."
+  },
+  "projectDir": {
+    "configured": "Project directory configured",
+    "directory": "Directory: {{path}}",
+    "configLink": "Config:    {{symlink}} -> {{dataPath}}"
+  },
+  "setup": {
+    "title": "Spck Networking CLI - Initial Setup",
+    "description1": "This wizard will help you configure the Spck Networking CLI.",
+    "description2": "The CLI connects to a proxy server to enable remote access",
+    "description3": "to your local filesystem, git, and terminal.",
+    "projectConfig": "Project Configuration",
+    "rootDirPrompt": "Root directory to serve [{{default}}]: ",
+    "terminalConfig": "Terminal Configuration",
+    "terminalDescription": "Terminal service allows remote shell access to your machine.",
+    "terminalPrompt": "Enable terminal service? [Y/n]: ",
+    "advancedTerminalPrompt": "Configure advanced terminal settings? [y/N]: ",
+    "maxBufferPrompt": "Maximum buffer lines (terminal history) [{{default}}]: ",
+    "maxBufferHint": "(Larger buffer stores more history but may slow synchronization)",
+    "maxTerminalsPrompt": "Maximum terminal processes [{{default}}]: ",
+    "browserProxyConfig": "Browser Proxy Configuration",
+    "browserProxyDescription": "Browser proxy allows Spck Editor to open a live preview of your local dev server inside the browser.",
+    "browserProxyPrompt": "Enable browser proxy service? [Y/n]: ",
+    "securityConfig": "Security Configuration",
+    "securityDescription1": "Additional user authentication adds an extra security layer",
+    "securityDescription2": "by requiring the client to verify their Firebase identity.",
+    "securityDescription3": "This increases initial connection time by ~3-15 seconds.",
+    "securityDocsHint": "Learn more: {{url}}",
+    "securityPrompt": "Enable additional user authentication? [y/N]: ",
+    "gitConfig": "Git Configuration",
+    "gitignoreDetected": "A .gitignore file was detected in your project directory.",
+    "gitignoreRecommend1": "It is recommended to add .spck-editor/ to .gitignore to prevent",
+    "gitignoreRecommend2": "accidentally committing the directory to version control.",
+    "gitignorePrompt": "Add .spck-editor/ to .gitignore? [Y/n]: ",
+    "gitignoreAdded": "Added .spck-editor/ to .gitignore",
+    "gitignoreFailed": "Failed to update .gitignore: {{message}}",
+    "gitignoreManualHint": "You can manually add .spck-editor/ to your .gitignore file.",
+    "setupFailed": "Setup failed: {{message}}",
+    "configSummary": "Configuration summary:",
+    "summaryName": "Server name: {{name}}",
+    "summaryNameNotSet": "Not set",
+    "summaryRoot": "Root directory: {{root}}",
+    "summaryTerminal": "Terminal service: {{status}}",
+    "summaryEnabled": "Enabled",
+    "summaryDisabled": "Disabled",
+    "summaryMaxBuffer": "- Max buffer lines: {{value}}",
+    "summaryMaxProcesses": "- Max processes: {{value}}",
+    "summaryUserAuth": "User authentication: {{status}}",
+    "summaryBrowserProxy": "Browser proxy: {{status}}",
+    "received": "Received {{signal}}"
+  }
+}