@fgv/ts-res-browser-cli 5.0.0-9 → 5.0.1-1

package/src/options.ts

@@ -1,139 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Options for launching the ts-res browser
- */
-export interface IBrowseOptions {
-  /**
-   * Input file or directory path
-   */
-  input?: string;
-
-  /**
-   * System configuration file path (JSON file in ISystemConfiguration format)
-   * or predefined configuration name
-   */
-  config?: string;
-
-  /**
-   * Context filter token (pipe-separated qualifier=value pairs, e.g., 'language=en-US|territory=US')
-   */
-  contextFilter?: string;
-
-  /**
-   * Qualifier default values token (pipe-separated qualifier=value pairs, e.g., 'language=en-US,en-CA|territory=US')
-   */
-  qualifierDefaults?: string;
-
-  /**
-   * Resource types filter (comma-separated, e.g., 'json,string')
-   */
-  resourceTypes?: string;
-
-  /**
-   * Maximum distance for language matching
-   */
-  maxDistance?: number;
-
-  /**
-   * Whether to reduce qualifiers when filtering by context
-   */
-  reduceQualifiers?: boolean;
-
-  /**
-   * Whether to run in verbose mode
-   */
-  verbose?: boolean;
-
-  /**
-   * Whether to run in quiet mode
-   */
-  quiet?: boolean;
-
-  /**
-   * Port to run the development server on (for launching locally)
-   */
-  port?: number;
-
-  /**
-   * Whether to open the browser automatically
-   */
-  open?: boolean;
-
-  /**
-   * Whether to launch in interactive mode (with sample data)
-   */
-  interactive?: boolean;
-
-  /**
-   * Browser URL to launch (for remote instances)
-   */
-  url?: string;
-
-  /**
-   * Whether to automatically start the development server
-   */
-  dev?: boolean;
-
-  /**
-   * Whether to start server (dev in monorepo, serve in published packages) and connect automatically
-   */
-  serve?: boolean;
-
-  /**
-   * Whether to use ZIP loading mode (internal flag)
-   */
-  loadZip?: boolean;
-
-  /**
-   * Path to ZIP file to load (internal flag)
-   */
-  zipPath?: string;
-
-  /**
-   * Name of ZIP file to load (internal flag)
-   */
-  zipFile?: string;
-}
-
-/**
- * Command-line options for the browse command
- */
-export interface IBrowseCommandOptions {
-  input?: string;
-  config?: string;
-  context?: string;
-  contextFilter?: string;
-  qualifierDefaults?: string;
-  resourceTypes?: string;
-  maxDistance?: number;
-  reduceQualifiers?: boolean;
-  verbose?: boolean;
-  quiet?: boolean;
-  port?: number;
-  open?: boolean;
-  interactive?: boolean;
-  url?: string;
-  dev?: boolean;
-  serve?: boolean;
-}

package/src/simpleBrowserLauncher.ts

@@ -1,278 +0,0 @@
-/*
- * Copyright (c) 2025 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { exec } from 'child_process';
-import * as path from 'path';
-import * as http from 'http';
-import { Result, succeed, fail } from '@fgv/ts-utils';
-import { IBrowseOptions } from './options';
-import { zipArchiver } from './zipArchiver';
-
-/**
- * Simplified browser launcher using direct dependency on ts-res-browser
- */
-export class SimpleBrowserLauncher {
-  /**
-   * Launches the browser with the specified options
-   */
-  public async launch(options: IBrowseOptions): Promise<Result<void>> {
-    try {
-      // Validate options before proceeding
-      if (options.interactive && !options.dev && !options.serve && !options.url) {
-        return fail(
-          'Interactive mode requires either --dev/--serve to start a local server or --url to specify a remote server.\n\n' +
-            'Examples:\n' +
-            '  ts-res-browser-cli --interactive --dev\n' +
-            '  ts-res-browser-cli --interactive --serve\n' +
-            '  ts-res-browser-cli --interactive --url https://example.com/ts-res-browser'
-        );
-      }
-
-      // Check if we need to create a ZIP archive for file-based inputs
-      let zipCreated = false;
-      let finalOptions = { ...options };
-
-      if (this._shouldCreateZip(options)) {
-        if (!options.quiet) {
-          console.log('Creating ZIP archive for file-based resources...');
-        }
-
-        const zipResult = await this._createZipArchive(options);
-        if (zipResult.isFailure()) {
-          return fail(`Failed to create ZIP archive: ${zipResult.message}`);
-        }
-
-        if (!options.quiet) {
-          console.log(`ZIP archive created: ${zipResult.value.zipPath}`);
-        }
-
-        // Modify options to use ZIP loading instead of file paths
-        const zipFileName = path.basename(zipResult.value.zipPath);
-        finalOptions = {
-          ...options,
-          input: undefined,
-          config: undefined,
-          // Add ZIP loading parameters
-          loadZip: true,
-          zipFile: zipFileName,
-          zipPath: zipResult.value.zipPath
-        };
-        zipCreated = true;
-      }
-
-      // Start server if requested
-      if ((finalOptions.dev || finalOptions.serve) && !finalOptions.url) {
-        if (!finalOptions.quiet) {
-          console.log('Starting TS-RES Browser server...');
-        }
-
-        const serverResult = await this._startServer(finalOptions);
-        if (serverResult.isFailure()) {
-          return serverResult;
-        }
-      }
-
-      // Build URL with parameters
-      const url = this._buildUrl(finalOptions);
-
-      if (!finalOptions.quiet) {
-        console.log('Opening TS-RES Browser...');
-        if (zipCreated) {
-          console.log('ZIP archive created - browser will load from Downloads folder');
-        } else {
-          if (finalOptions.input) {
-            console.log(`Resource file: ${finalOptions.input}`);
-          }
-          if (finalOptions.config) {
-            console.log(`Configuration: ${finalOptions.config}`);
-          }
-        }
-        if (finalOptions.contextFilter) {
-          console.log(`Context filter: ${finalOptions.contextFilter}`);
-        }
-        console.log(`URL: ${url}`);
-      }
-
-      // Open browser if requested (default to true)
-      const shouldOpen = finalOptions.open !== false;
-      if (shouldOpen) {
-        const openResult = await this._openBrowser(url, finalOptions.verbose || false);
-        if (openResult.isFailure()) {
-          return fail(`Could not open browser: ${openResult.message}`);
-        }
-
-        if (!finalOptions.quiet) {
-          console.log('Browser opened successfully');
-        }
-      } else {
-        console.log(`Browser URL: ${url}`);
-      }
-
-      return succeed(undefined);
-    } catch (error) {
-      return fail(`Failed to launch browser: ${error}`);
-    }
-  }
-
-  /**
-   * Starts the server using ts-res-browser CLI directly
-   */
-  private async _startServer(options: IBrowseOptions): Promise<Result<void>> {
-    try {
-      // Use ts-res-browser directly from node_modules
-      const browserPath = require.resolve('@fgv/ts-res-browser/cli.js');
-      const command = `node "${browserPath}" ${options.dev ? 'dev' : 'serve'}`;
-
-      if (options.verbose) {
-        console.log(`Running: ${command}`);
-      }
-
-      return new Promise((resolve) => {
-        const child = exec(command, (error) => {
-          if (error) {
-            resolve(fail(`Failed to start server: ${error.message}`));
-          } else {
-            resolve(succeed(undefined));
-          }
-        });
-
-        // Give server time to start, then assume success
-        setTimeout(() => {
-          if (options.verbose) {
-            console.log('Server startup initiated');
-          }
-          resolve(succeed(undefined));
-        }, 2000);
-      });
-    } catch (error) {
-      return fail(`Failed to start server: ${error}`);
-    }
-  }
-
-  /**
-   * Opens the browser to the specified URL
-   */
-  private async _openBrowser(url: string, verbose: boolean): Promise<Result<void>> {
-    return new Promise((resolve) => {
-      const command =
-        process.platform === 'darwin' ? 'open' : process.platform === 'win32' ? 'start ""' : 'xdg-open';
-
-      exec(`${command} "${url}"`, (error) => {
-        if (error) {
-          resolve(fail(`Failed to open browser: ${error.message}`));
-        } else {
-          if (verbose) {
-            console.log(`Opened browser to: ${url}`);
-          }
-          resolve(succeed(undefined));
-        }
-      });
-    });
-  }
-
-  /**
-   * Builds the URL with query parameters based on options
-   */
-  private _buildUrl(options: IBrowseOptions): string {
-    // Use provided URL or default based on server type
-    const defaultPort = options.dev ? 3000 : 8080;
-    const baseUrl = options.url || `http://localhost:${options.port || defaultPort}`;
-    const params = new URLSearchParams();
-
-    if (options.input) {
-      params.set('input', options.input);
-    }
-
-    if (options.config) {
-      params.set('config', options.config);
-    }
-
-    if (options.contextFilter) {
-      params.set('contextFilter', options.contextFilter);
-    }
-
-    if (options.qualifierDefaults) {
-      params.set('qualifierDefaults', options.qualifierDefaults);
-    }
-
-    if (options.resourceTypes) {
-      params.set('resourceTypes', options.resourceTypes);
-    }
-
-    if (options.maxDistance !== undefined) {
-      params.set('maxDistance', options.maxDistance.toString());
-    }
-
-    if (options.reduceQualifiers) {
-      params.set('reduceQualifiers', 'true');
-    }
-
-    if (options.interactive) {
-      params.set('interactive', 'true');
-    }
-
-    if (options.loadZip) {
-      params.set('loadZip', 'true');
-    }
-
-    if (options.zipFile) {
-      params.set('zipFile', options.zipFile);
-    }
-
-    if (options.zipPath) {
-      params.set('zipPath', options.zipPath);
-    }
-
-    const queryString = params.toString();
-    return queryString ? `${baseUrl}?${queryString}` : baseUrl;
-  }
-
-  /**
-   * Determines if a ZIP archive should be created based on the options
-   */
-  private _shouldCreateZip(options: IBrowseOptions): boolean {
-    // Create ZIP if input or config are file paths (not predefined names)
-    const hasFilePath = (path: string | undefined): boolean => {
-      if (!path) return false;
-      // Check if it's a file path (contains directory separators or file extensions)
-      return path.includes('/') || path.includes('\\') || (path.includes('.') && !path.startsWith('.'));
-    };
-
-    return hasFilePath(options.input) || hasFilePath(options.config);
-  }
-
-  /**
-   * Creates a ZIP archive containing the input and config files
-   */
-  private async _createZipArchive(
-    options: IBrowseOptions
-  ): Promise<Result<{ zipPath: string; manifest: any }>> {
-    try {
-      return await zipArchiver.createArchive({
-        input: options.input,
-        config: options.config
-      });
-    } catch (error) {
-      return fail(`Failed to create ZIP archive: ${error instanceof Error ? error.message : String(error)}`);
-    }
-  }
-}

package/src/zipArchiver.ts

@@ -1,153 +0,0 @@
-import * as archiver from 'archiver';
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import { Result, succeed, fail } from '@fgv/ts-utils';
-
-export interface ZipArchiveOptions {
-  input?: string;
-  config?: string;
-  outputDir?: string;
-}
-
-export interface ZipArchiveResult {
-  zipPath: string;
-  manifest: ZipManifest;
-}
-
-export interface ZipManifest {
-  timestamp: string;
-  input?: {
-    type: 'file' | 'directory';
-    originalPath: string;
-    archivePath: string;
-  };
-  config?: {
-    type: 'file';
-    originalPath: string;
-    archivePath: string;
-  };
-}
-
-export class ZipArchiver {
-  /**
-   * Create a ZIP archive containing the specified input and config files/directories
-   */
-  async createArchive(options: ZipArchiveOptions): Promise<Result<ZipArchiveResult>> {
-    try {
-      const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
-      const outputDir = options.outputDir || path.join(os.homedir(), 'Downloads');
-      const zipFileName = `ts-res-bundle-${timestamp}.zip`;
-      const zipPath = path.join(outputDir, zipFileName);
-
-      // Ensure output directory exists
-      if (!fs.existsSync(outputDir)) {
-        fs.mkdirSync(outputDir, { recursive: true });
-      }
-
-      const output = fs.createWriteStream(zipPath);
-      const archive = archiver.create('zip', {
-        zlib: { level: 6 } // Good compression level
-      });
-
-      // Create manifest
-      const manifest: ZipManifest = {
-        timestamp: new Date().toISOString()
-      };
-
-      // Promise to handle async archiving
-      const archivePromise = new Promise<void>((resolve, reject) => {
-        output.on('close', () => {
-          resolve();
-        });
-
-        output.on('error', (err: Error) => {
-          reject(err);
-        });
-
-        archive.on('error', (err: Error) => {
-          reject(err);
-        });
-      });
-
-      // Pipe archive data to the file
-      archive.pipe(output);
-
-      // Add input files/directory
-      if (options.input) {
-        const inputPath = path.resolve(options.input);
-
-        if (!fs.existsSync(inputPath)) {
-          return fail(`Input path does not exist: ${inputPath}`);
-        }
-
-        const stats = fs.statSync(inputPath);
-        if (stats.isDirectory()) {
-          // Add entire directory recursively, preserving structure
-          const dirName = path.basename(inputPath);
-          archive.directory(inputPath, `input/${dirName}`);
-          manifest.input = {
-            type: 'directory',
-            originalPath: inputPath,
-            archivePath: `input/${dirName}`
-          };
-        } else if (stats.isFile()) {
-          // Add single file
-          const fileName = path.basename(inputPath);
-          archive.file(inputPath, { name: `input/${fileName}` });
-          manifest.input = {
-            type: 'file',
-            originalPath: inputPath,
-            archivePath: `input/${fileName}`
-          };
-        }
-      }
-
-      // Add config file
-      if (options.config) {
-        const configPath = path.resolve(options.config);
-
-        if (!fs.existsSync(configPath)) {
-          return fail(`Config file does not exist: ${configPath}`);
-        }
-
-        const stats = fs.statSync(configPath);
-        if (!stats.isFile()) {
-          return fail(`Config path must be a file: ${configPath}`);
-        }
-
-        const fileName = path.basename(configPath);
-        archive.file(configPath, { name: `config/${fileName}` });
-        manifest.config = {
-          type: 'file',
-          originalPath: configPath,
-          archivePath: `config/${fileName}`
-        };
-      }
-
-      // Add manifest
-      archive.append(JSON.stringify(manifest, null, 2), { name: 'manifest.json' });
-
-      // Finalize the archive
-      await archive.finalize();
-      await archivePromise;
-
-      return succeed({
-        zipPath,
-        manifest
-      });
-    } catch (error) {
-      return fail(`Failed to create ZIP archive: ${error instanceof Error ? error.message : String(error)}`);
-    }
-  }
-
-  /**
-   * Get the default downloads directory path
-   */
-  getDefaultDownloadsDir(): string {
-    return path.join(os.homedir(), 'Downloads');
-  }
-}
-
-// Export singleton instance
-export const zipArchiver = new ZipArchiver();

package/tsconfig.json

@@ -1,7 +0,0 @@
-{
-  "extends": "./node_modules/@rushstack/heft-node-rig/profiles/default/tsconfig-base.json",
-  "compilerOptions": {
-    "types": ["node"],
-    "incremental": false
-  }
-}