@objectstack/cli 4.0.4 → 4.1.0

package/src/utils/studio.ts

@@ -1,350 +0,0 @@
-// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
-
-/**
- * Studio UI Integration Utilities
- *
- * Handles resolving, spawning, and proxying the @objectstack/studio
- * frontend when the CLI is started with --ui or via the `studio` command.
- */
-import path from 'path';
-import fs from 'fs';
-import net from 'net';
-import { createRequire } from 'module';
-import { pathToFileURL } from 'url';
-import { spawn, type ChildProcess } from 'child_process';
-import chalk from 'chalk';
-
-// ─── Constants ──────────────────────────────────────────────────────
-
-/** URL mount path for the Console UI inside the ObjectStack server */
-export const STUDIO_PATH = '/_studio';
-
-/** Internal port range start for the Vite dev server */
-const VITE_PORT_START = 24678;
-
-// ─── Path Resolution ────────────────────────────────────────────────
-
-/**
- * Resolve the filesystem path to the @objectstack/studio package.
- * Searches workspace locations first, then falls back to node_modules.
- */
-export function resolveStudioPath(): string | null {
-  const cwd = process.cwd();
-
-  // Workspace candidates (monorepo layouts)
-  const candidates = [
-    path.resolve(cwd, 'apps/studio'),
-    path.resolve(cwd, '../../apps/studio'),
-    path.resolve(cwd, '../apps/studio'),
-  ];
-
-  for (const candidate of candidates) {
-    const pkgPath = path.join(candidate, 'package.json');
-    if (fs.existsSync(pkgPath)) {
-      try {
-        const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-        if (pkg.name === '@objectstack/studio') return candidate;
-      } catch {
-        // Skip invalid package.json
-      }
-    }
-  }
-
-  // Fallback: resolve from node_modules via createRequire.
-  // Try the consumer's cwd first (pnpm strict isolation means the CLI's own
-  // import.meta.url cannot see the consumer's dependencies), then the CLI itself.
-  const resolutionBases = [
-    pathToFileURL(path.join(cwd, 'package.json')).href,  // consumer workspace
-    import.meta.url,                                       // CLI package itself
-  ];
-
-  for (const base of resolutionBases) {
-    try {
-      const req = createRequire(base);
-      const resolved = req.resolve('@objectstack/studio/package.json');
-      return path.dirname(resolved);
-    } catch {
-      // Not resolvable from this base — try next
-    }
-  }
-
-  // Last resort: direct filesystem check in cwd/node_modules
-  const directPath = path.join(cwd, 'node_modules', '@objectstack', 'studio');
-  if (fs.existsSync(path.join(directPath, 'package.json'))) {
-    return directPath;
-  }
-
-  return null;
-}
-
-/**
- * Check whether the Studio has a pre-built `dist/` directory.
- */
-export function hasStudioDist(studioPath: string): boolean {
-  return fs.existsSync(path.join(studioPath, 'dist', 'index.html'));
-}
-
-// ─── Port Utilities ─────────────────────────────────────────────────
-
-/**
- * Find the next available TCP port starting from `start`.
- */
-export function findAvailablePort(start: number = VITE_PORT_START): Promise<number> {
-  return new Promise((resolve, reject) => {
-    const server = net.createServer();
-    server.once('error', () => {
-      // Port in use — try next
-      findAvailablePort(start + 1).then(resolve, reject);
-    });
-    server.once('listening', () => {
-      server.close(() => resolve(start));
-    });
-    server.listen(start);
-  });
-}
-
-// ─── Vite Dev Server ────────────────────────────────────────────────
-
-export interface ViteDevResult {
-  /** Port the Vite dev server is listening on */
-  port: number;
-  /** Child process handle */
-  process: ChildProcess;
-}
-
-/**
- * Spawn a Vite dev server for the Console application.
- *
- * Sets environment variables so the Console runs in server mode and
- * connects to the ObjectStack API on the same origin.
- *
- * @param studioPath - Absolute path to the @objectstack/studio package
- * @param options.serverPort - The main ObjectStack server port (for display only)
- */
-export async function spawnViteDevServer(
-  studioPath: string,
-  options: { serverPort?: number } = {},
-): Promise<ViteDevResult> {
-  const vitePort = await findAvailablePort(VITE_PORT_START);
-
-  // Resolve the Vite binary from the Studio's own dependencies
-  const viteBinCandidates = [
-    path.join(studioPath, 'node_modules', '.bin', 'vite'),
-    path.join(studioPath, '..', '..', 'node_modules', '.bin', 'vite'),
-  ];
-
-  let viteBin: string | null = null;
-  for (const candidate of viteBinCandidates) {
-    if (fs.existsSync(candidate)) {
-      viteBin = candidate;
-      break;
-    }
-  }
-
-  const command = viteBin || 'npx';
-  const args = viteBin
-    ? ['--port', String(vitePort), '--strictPort']
-    : ['vite', '--port', String(vitePort), '--strictPort'];
-
-  const child = spawn(command, args, {
-    cwd: studioPath,
-    env: {
-      ...process.env,
-      VITE_BASE: `${STUDIO_PATH}/`,
-      VITE_PORT: String(vitePort),
-      VITE_HMR_PORT: String(vitePort),
-      VITE_RUNTIME_MODE: 'server',
-      VITE_SERVER_URL: '',             // Same-origin API
-      NODE_ENV: 'development',
-    },
-    stdio: ['ignore', 'pipe', 'pipe'],
-  });
-
-  // Accumulate stderr for error reporting
-  let stderr = '';
-  child.stderr?.on('data', (data: Buffer) => {
-    stderr += data.toString();
-  });
-
-  // Wait for Vite to signal readiness
-  await new Promise<void>((resolve, reject) => {
-    const timeout = setTimeout(() => {
-      child.kill();
-      reject(new Error(`Vite dev server timed out after 30 s.\n${stderr}`));
-    }, 30_000);
-
-    child.stdout?.on('data', (data: Buffer) => {
-      const output = data.toString();
-      // Vite prints "ready in Xms" or "Local: http://..." when ready
-      if (output.includes('Local:') || output.includes('ready in')) {
-        clearTimeout(timeout);
-        resolve();
-      }
-    });
-
-    child.on('error', (err) => {
-      clearTimeout(timeout);
-      reject(err);
-    });
-
-    child.on('exit', (code) => {
-      if (code !== 0 && code !== null) {
-        clearTimeout(timeout);
-        reject(new Error(`Vite exited with code ${code}.\n${stderr}`));
-      }
-    });
-  });
-
-  return { port: vitePort, process: child };
-}
-
-// ─── Console Plugin Factories ───────────────────────────────────────
-
-/**
- * Create a lightweight kernel plugin that proxies `/_studio/*` requests
- * to the Vite dev server. Used in development mode.
- */
-export function createStudioProxyPlugin(vitePort: number) {
-  return {
-    name: 'com.objectstack.studio-proxy',
-
-    init: async () => {},
-
-    start: async (ctx: any) => {
-      const httpServer = ctx.getService?.('http.server');
-      if (!httpServer?.getRawApp) {
-        ctx.logger?.warn?.('Studio proxy: http.server service not found — skipping');
-        return;
-      }
-
-      const app = httpServer.getRawApp();
-
-      // Redirect bare path to trailing-slash (SPA convention)
-      app.get(STUDIO_PATH, (c: any) => c.redirect(`${STUDIO_PATH}/`));
-
-      // Proxy all /_studio/* requests to the Vite dev server
-      app.all(`${STUDIO_PATH}/*`, async (c: any) => {
-        const targetUrl = `http://localhost:${vitePort}${c.req.path}`;
-
-        try {
-          const headers = new Headers(c.req.raw.headers);
-          headers.delete('host');
-
-          const isBodyAllowed = !['GET', 'HEAD'].includes(c.req.method);
-
-          const resp = await fetch(targetUrl, {
-            method: c.req.method,
-            headers,
-            body: isBodyAllowed ? c.req.raw.body : undefined,
-            duplex: isBodyAllowed ? 'half' : undefined,
-          } as RequestInit);
-
-          // Forward the full response (status, headers, body)
-          return new Response(resp.body, {
-            status: resp.status,
-            headers: resp.headers,
-          });
-        } catch {
-          return c.text('Console dev server is starting…', 502);
-        }
-      });
-    },
-  };
-}
-
-/**
- * Create a lightweight kernel plugin that serves the pre-built Studio
- * static files at `/_studio/*`. Used in production mode.
- *
- * Uses Node.js built-in fs for static file serving to avoid external
- * bundling dependencies.
- */
-export function createStudioStaticPlugin(distPath: string, options?: { isDev?: boolean }) {
-  return {
-    name: 'com.objectstack.studio-static',
-
-    init: async () => {},
-
-    start: async (ctx: any) => {
-      const httpServer = ctx.getService?.('http.server');
-      if (!httpServer?.getRawApp) {
-        ctx.logger?.warn?.('Studio static: http.server service not found — skipping');
-        return;
-      }
-
-      const app = httpServer.getRawApp();
-      const absoluteDist = path.resolve(distPath);
-
-      const indexPath = path.join(absoluteDist, 'index.html');
-      if (!fs.existsSync(indexPath)) {
-        ctx.logger?.warn?.(`Studio static: dist not found at ${absoluteDist}`);
-        return;
-      }
-
-      // Read and rewrite index.html so asset paths respect the mount path.
-      // The dist may have been built with base '/' (absolute paths like
-      // /assets/...) which won't resolve when mounted under /_studio/.
-      const rawHtml = fs.readFileSync(indexPath, 'utf-8');
-      const rewrittenHtml = rawHtml.replace(
-        /(\s(?:href|src))="\/(?!\/)/g,
-        `$1="${STUDIO_PATH}/`,
-      );
-
-      // In dev mode, redirect root to Studio for convenience
-      if (options?.isDev) {
-        app.get('/', (c: any) => c.redirect(`${STUDIO_PATH}/`));
-      }
-      // Redirect bare path
-      app.get(STUDIO_PATH, (c: any) => c.redirect(`${STUDIO_PATH}/`));
-
-      // Serve static files with SPA fallback
-      app.get(`${STUDIO_PATH}/*`, async (c: any) => {
-        const reqPath = c.req.path.substring(STUDIO_PATH.length) || '/';
-        const filePath = path.join(absoluteDist, reqPath);
-
-        // Security: prevent path traversal
-        if (!filePath.startsWith(absoluteDist)) {
-          return c.text('Forbidden', 403);
-        }
-
-        // Try serving the exact file
-        if (fs.existsSync(filePath) && fs.statSync(filePath).isFile()) {
-          const content = fs.readFileSync(filePath);
-          return new Response(content, {
-            headers: { 'content-type': mimeType(filePath) },
-          });
-        }
-
-        // SPA fallback: serve rewritten index.html for non-file routes
-        return new Response(rewrittenHtml, {
-          headers: { 'content-type': 'text/html; charset=utf-8' },
-        });
-      });
-    },
-  };
-}
-
-// ─── Helpers ────────────────────────────────────────────────────────
-
-const MIME_TYPES: Record<string, string> = {
-  '.html': 'text/html; charset=utf-8',
-  '.js':   'application/javascript; charset=utf-8',
-  '.mjs':  'application/javascript; charset=utf-8',
-  '.css':  'text/css; charset=utf-8',
-  '.json': 'application/json; charset=utf-8',
-  '.svg':  'image/svg+xml',
-  '.png':  'image/png',
-  '.jpg':  'image/jpeg',
-  '.jpeg': 'image/jpeg',
-  '.gif':  'image/gif',
-  '.ico':  'image/x-icon',
-  '.woff': 'font/woff',
-  '.woff2': 'font/woff2',
-  '.ttf':  'font/ttf',
-  '.map':  'application/json',
-};
-
-function mimeType(filePath: string): string {
-  const ext = path.extname(filePath).toLowerCase();
-  return MIME_TYPES[ext] || 'application/octet-stream';
-}

package/test/commands.test.ts

@@ -1,128 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import Compile from '../src/commands/compile';
-import Serve from '../src/commands/serve';
-import Dev from '../src/commands/dev';
-import Doctor from '../src/commands/doctor';
-import Create from '../src/commands/create';
-import Test from '../src/commands/test';
-import Validate from '../src/commands/validate';
-import Init from '../src/commands/init';
-import Info from '../src/commands/info';
-import Generate from '../src/commands/generate';
-import Lint from '../src/commands/lint';
-import Diff from '../src/commands/diff';
-import Explain from '../src/commands/explain';
-import Studio from '../src/commands/studio';
-import PluginList from '../src/commands/plugin/list';
-import PluginInfo from '../src/commands/plugin/info';
-import PluginAdd from '../src/commands/plugin/add';
-import PluginRemove from '../src/commands/plugin/remove';
-import PluginBuild from '../src/commands/plugin/build';
-import PluginValidate from '../src/commands/plugin/validate';
-import PluginPublish from '../src/commands/plugin/publish';
-import V2ToV3 from '../src/commands/codemod/v2-to-v3';
-
-describe('CLI Commands (oclif)', () => {
-  it('should have compile command', () => {
-    expect(Compile.description).toContain('Compile');
-  });
-
-  it('should have serve command', () => {
-    expect(Serve.description).toContain('server');
-  });
-
-  it('should have dev command', () => {
-    expect(Dev.description).toContain('development mode');
-  });
-
-  it('should have doctor command', () => {
-    expect(Doctor.description).toContain('health');
-  });
-
-  it('should have create command', () => {
-    expect(Create.description).toContain('Create');
-  });
-
-  it('should have test command', () => {
-    expect(Test.description).toContain('Quality Protocol');
-  });
-
-  it('should have validate command', () => {
-    expect(Validate.description).toContain('Validate');
-  });
-
-  it('should have init command', () => {
-    expect(Init.description).toContain('Initialize');
-  });
-
-  it('should have info command', () => {
-    expect(Info.description).toContain('summary');
-  });
-
-  it('should have generate command with alias', () => {
-    expect(Generate.aliases).toContain('g');
-    expect(Generate.description).toContain('Generate');
-  });
-
-  it('should have lint command', () => {
-    expect(Lint.description).toContain('style');
-  });
-
-  it('should have diff command', () => {
-    expect(Diff.description).toContain('Compare');
-  });
-
-  it('should have explain command', () => {
-    expect(Explain.description).toContain('explanation');
-  });
-
-  it('should have studio command', () => {
-    expect(Studio.description).toContain('Studio');
-  });
-
-  it('should have codemod v2-to-v3 command', () => {
-    expect(V2ToV3.description).toContain('v2');
-  });
-
-  describe('Plugin subcommands', () => {
-    it('should have plugin list command', () => {
-      expect(PluginList.description).toContain('List');
-    });
-
-    it('should have plugin info command', () => {
-      expect(PluginInfo.description).toContain('information');
-    });
-
-    it('should have plugin add command', () => {
-      expect(PluginAdd.description).toContain('Add');
-    });
-
-    it('should have plugin remove command', () => {
-      expect(PluginRemove.description).toContain('Remove');
-    });
-
-    it('should have plugin remove alias', () => {
-      expect(PluginRemove.aliases).toContain('plugin rm');
-    });
-
-    it('should have plugin list alias', () => {
-      expect(PluginList.aliases).toContain('plugin ls');
-    });
-
-    it('should have plugin build command', () => {
-      expect(PluginBuild.description).toContain('Build');
-    });
-
-    it('should have plugin build alias', () => {
-      expect(PluginBuild.aliases).toContain('plugin pack');
-    });
-
-    it('should have plugin validate command', () => {
-      expect(PluginValidate.description).toContain('Validate');
-    });
-
-    it('should have plugin publish command', () => {
-      expect(PluginPublish.description).toContain('Publish');
-    });
-  });
-});

package/test/create.test.ts

@@ -1,25 +0,0 @@
-import { describe, it, expect } from 'vitest';
-import { templates } from '../src/commands/create';
-
-describe('Create Command Templates', () => {
-  describe('Example Template', () => {
-    it('should generate correct package.json scripts', () => {
-      const packageJsonFn = templates.example.files['package.json'];
-      const packageJson = packageJsonFn('test-app');
-      
-      expect(packageJson.scripts.dev).toBe('objectstack dev');
-      expect(packageJson.scripts.build).toBe('objectstack compile');
-      expect(packageJson.dependencies['@objectstack/cli']).toBe('workspace:*');
-    });
-  });
-
-  describe('Plugin Template', () => {
-    it('should generate correct dependencies', () => {
-        const packageJsonFn = templates.plugin.files['package.json'];
-        const packageJson = packageJsonFn('test-plugin');
-        
-        expect(packageJson.dependencies).toHaveProperty('@objectstack/spec');
-        expect(packageJson.keywords).toContain('test-plugin');
-    });
-  });
-});

package/test/plugin-commands.test.ts

@@ -1,44 +0,0 @@
-import { describe, it, expect } from 'vitest';
-
-/**
- * The custom loadPluginCommands mechanism has been removed.
- * Plugin command extension is now handled by oclif's built-in plugin system.
- *
- * Plugins extend the CLI by:
- * 1. Including `oclif` config in their package.json
- * 2. Exporting oclif Command classes from `src/commands/`
- * 3. Being installed via `os plugins install <package>`
- *
- * The objectstack.config.ts no longer determines CLI command availability.
- */
-
-describe('oclif Plugin System', () => {
-  it('should have oclif plugins configured in package.json', async () => {
-    const { createRequire } = await import('module');
-    const require = createRequire(import.meta.url);
-    const pkg = require('../package.json');
-
-    expect(pkg.oclif).toBeDefined();
-    expect(pkg.oclif.plugins).toContain('@oclif/plugin-help');
-    expect(pkg.oclif.plugins).toContain('@oclif/plugin-plugins');
-  });
-
-  it('should have oclif command discovery configured', async () => {
-    const { createRequire } = await import('module');
-    const require = createRequire(import.meta.url);
-    const pkg = require('../package.json');
-
-    expect(pkg.oclif.commands).toBeDefined();
-    expect(pkg.oclif.commands.strategy).toBe('pattern');
-    expect(pkg.oclif.commands.target).toBe('./dist/commands');
-  });
-
-  it('should have bin entries pointing to oclif runner', async () => {
-    const { createRequire } = await import('module');
-    const require = createRequire(import.meta.url);
-    const pkg = require('../package.json');
-
-    expect(pkg.bin.os).toBe('./bin/run.js');
-    expect(pkg.bin.objectstack).toBe('./bin/run.js');
-  });
-});