@vizzly-testing/cli 0.20.0 → 0.20.1-beta.0

package/dist/config/operations.js

@@ -0,0 +1,327 @@
+/**
+ * Config Operations - Configuration operations with dependency injection
+ *
+ * Each operation takes its dependencies as parameters:
+ * - explorer: cosmiconfig explorer for project config
+ * - globalConfigStore: for reading/writing global config
+ * - fileWriter: for writing project config files
+ *
+ * This makes them trivially testable without mocking modules.
+ */
+
+import { join } from 'node:path';
+import { VizzlyError } from '../errors/vizzly-error.js';
+import { buildGlobalConfigResult, buildMergedConfigResult, buildProjectConfigResult, deepMerge, extractCosmiconfigResult, extractEnvOverrides, getConfigFormat, serializeConfig, validateReadScope, validateWriteScope } from './core.js';
+
+// ============================================================================
+// Read Operations
+// ============================================================================
+
+/**
+ * Get project-level config from vizzly.config.js or similar
+ * @param {Object} explorer - Cosmiconfig explorer with search method
+ * @param {string} projectRoot - Project root directory
+ * @returns {Promise<{ config: Object, filepath: string|null, isEmpty: boolean }>}
+ */
+export async function getProjectConfig(explorer, projectRoot) {
+  let result = explorer.search(projectRoot);
+  let {
+    config,
+    filepath
+  } = extractCosmiconfigResult(result);
+  return buildProjectConfigResult(config, filepath);
+}
+
+/**
+ * Get global config from ~/.vizzly/config.json
+ * @param {Object} globalConfigStore - Store with load and getPath methods
+ * @returns {Promise<{ config: Object, filepath: string, isEmpty: boolean }>}
+ */
+export async function getGlobalConfig(globalConfigStore) {
+  let config = await globalConfigStore.load();
+  let filepath = globalConfigStore.getPath();
+  return buildGlobalConfigResult(config, filepath);
+}
+
+/**
+ * Get merged config from all sources with source tracking
+ * @param {Object} options - Options
+ * @param {Object} options.explorer - Cosmiconfig explorer
+ * @param {Object} options.globalConfigStore - Global config store
+ * @param {string} options.projectRoot - Project root directory
+ * @param {Object} [options.env] - Environment variables (defaults to process.env)
+ * @returns {Promise<{ config: Object, sources: Object, projectFilepath: string|null, globalFilepath: string }>}
+ */
+export async function getMergedConfig({
+  explorer,
+  globalConfigStore,
+  projectRoot,
+  env = process.env
+}) {
+  let projectConfigData = await getProjectConfig(explorer, projectRoot);
+  let globalConfigData = await getGlobalConfig(globalConfigStore);
+  let envOverrides = extractEnvOverrides(env);
+  return buildMergedConfigResult({
+    projectConfig: projectConfigData.config,
+    globalConfig: globalConfigData.config,
+    envOverrides,
+    projectFilepath: projectConfigData.filepath,
+    globalFilepath: globalConfigData.filepath
+  });
+}
+
+/**
+ * Get configuration based on scope
+ * @param {Object} options - Options
+ * @param {string} options.scope - 'project', 'global', or 'merged'
+ * @param {Object} options.explorer - Cosmiconfig explorer
+ * @param {Object} options.globalConfigStore - Global config store
+ * @param {string} options.projectRoot - Project root directory
+ * @param {Object} [options.env] - Environment variables
+ * @returns {Promise<Object>} Config result based on scope
+ */
+export async function getConfig({
+  scope = 'merged',
+  explorer,
+  globalConfigStore,
+  projectRoot,
+  env
+}) {
+  let validation = validateReadScope(scope);
+  if (!validation.valid) {
+    throw validation.error;
+  }
+  if (scope === 'project') {
+    return getProjectConfig(explorer, projectRoot);
+  }
+  if (scope === 'global') {
+    return getGlobalConfig(globalConfigStore);
+  }
+  return getMergedConfig({
+    explorer,
+    globalConfigStore,
+    projectRoot,
+    env
+  });
+}
+
+// ============================================================================
+// Write Operations
+// ============================================================================
+
+/**
+ * Update project-level config
+ * @param {Object} options - Options
+ * @param {Object} options.updates - Config updates to apply
+ * @param {Object} options.explorer - Cosmiconfig explorer
+ * @param {string} options.projectRoot - Project root directory
+ * @param {Function} options.writeFile - Async file writer (path, content) => Promise
+ * @param {Function} options.readFile - Async file reader (path) => Promise<string>
+ * @param {Function} options.validate - Config validator
+ * @returns {Promise<{ config: Object, filepath: string }>}
+ */
+export async function updateProjectConfig({
+  updates,
+  explorer,
+  projectRoot,
+  writeFile,
+  readFile,
+  validate
+}) {
+  let result = explorer.search(projectRoot);
+  let {
+    config: currentConfig,
+    filepath: configPath
+  } = extractCosmiconfigResult(result);
+
+  // Determine config file path - create new if none exists
+  if (!configPath) {
+    configPath = join(projectRoot, 'vizzly.config.js');
+    currentConfig = {};
+  }
+
+  // Merge updates with current config
+  let newConfig = deepMerge(currentConfig, updates);
+
+  // Validate before writing
+  try {
+    validate(newConfig);
+  } catch (error) {
+    throw new VizzlyError(`Invalid configuration: ${error.message}`, 'CONFIG_VALIDATION_ERROR', {
+      errors: error.errors
+    });
+  }
+
+  // Write config file based on format
+  await writeProjectConfigFile({
+    filepath: configPath,
+    config: newConfig,
+    writeFile,
+    readFile
+  });
+
+  // Clear cosmiconfig cache
+  explorer.clearCaches();
+  return {
+    config: newConfig,
+    filepath: configPath
+  };
+}
+
+/**
+ * Write project config to file
+ * @param {Object} options - Options
+ * @param {string} options.filepath - Path to write to
+ * @param {Object} options.config - Config object
+ * @param {Function} options.writeFile - Async file writer
+ * @param {Function} options.readFile - Async file reader (for package.json)
+ * @returns {Promise<void>}
+ */
+export async function writeProjectConfigFile({
+  filepath,
+  config,
+  writeFile,
+  readFile
+}) {
+  let format = getConfigFormat(filepath);
+  if (format === 'package') {
+    // For package.json, merge into existing
+    let pkgContent = await readFile(filepath);
+    let pkg;
+    try {
+      pkg = JSON.parse(pkgContent);
+    } catch (error) {
+      throw new VizzlyError(`Failed to parse package.json: ${error.message}`, 'INVALID_PACKAGE_JSON');
+    }
+    pkg.vizzly = config;
+    await writeFile(filepath, JSON.stringify(pkg, null, 2));
+    return;
+  }
+  let serialized = serializeConfig(config, filepath);
+  if (serialized.error) {
+    throw serialized.error;
+  }
+  await writeFile(filepath, serialized.content);
+}
+
+/**
+ * Update global config
+ * @param {Object} options - Options
+ * @param {Object} options.updates - Config updates to apply
+ * @param {Object} options.globalConfigStore - Global config store with load and save methods
+ * @returns {Promise<{ config: Object, filepath: string }>}
+ */
+export async function updateGlobalConfig({
+  updates,
+  globalConfigStore
+}) {
+  let currentConfig = await globalConfigStore.load();
+  let newConfig = deepMerge(currentConfig, updates);
+  await globalConfigStore.save(newConfig);
+  return {
+    config: newConfig,
+    filepath: globalConfigStore.getPath()
+  };
+}
+
+/**
+ * Update configuration based on scope
+ * @param {Object} options - Options
+ * @param {string} options.scope - 'project' or 'global'
+ * @param {Object} options.updates - Config updates to apply
+ * @param {Object} options.explorer - Cosmiconfig explorer
+ * @param {Object} options.globalConfigStore - Global config store
+ * @param {string} options.projectRoot - Project root directory
+ * @param {Function} options.writeFile - Async file writer
+ * @param {Function} options.readFile - Async file reader
+ * @param {Function} options.validate - Config validator
+ * @returns {Promise<{ config: Object, filepath: string }>}
+ */
+export async function updateConfig({
+  scope,
+  updates,
+  explorer,
+  globalConfigStore,
+  projectRoot,
+  writeFile,
+  readFile,
+  validate
+}) {
+  let validation = validateWriteScope(scope);
+  if (!validation.valid) {
+    throw validation.error;
+  }
+  if (scope === 'project') {
+    return updateProjectConfig({
+      updates,
+      explorer,
+      projectRoot,
+      writeFile,
+      readFile,
+      validate
+    });
+  }
+  return updateGlobalConfig({
+    updates,
+    globalConfigStore
+  });
+}
+
+// ============================================================================
+// Validation Operations
+// ============================================================================
+
+/**
+ * Validate configuration object
+ * @param {Object} config - Config to validate
+ * @param {Function} validateFn - Validation function
+ * @returns {{ valid: boolean, config: Object|null, errors: Array }}
+ */
+export function validateConfig(config, validateFn) {
+  try {
+    let validated = validateFn(config);
+    return {
+      valid: true,
+      config: validated,
+      errors: []
+    };
+  } catch (error) {
+    return {
+      valid: false,
+      config: null,
+      errors: error.errors || [{
+        message: error.message
+      }]
+    };
+  }
+}
+
+// ============================================================================
+// Source Lookup
+// ============================================================================
+
+/**
+ * Get the source of a specific config key
+ * @param {Object} options - Options
+ * @param {string} options.key - Config key to look up
+ * @param {Object} options.explorer - Cosmiconfig explorer
+ * @param {Object} options.globalConfigStore - Global config store
+ * @param {string} options.projectRoot - Project root directory
+ * @param {Object} [options.env] - Environment variables
+ * @returns {Promise<string>} Source ('default', 'global', 'project', 'env', 'unknown')
+ */
+export async function getConfigSource({
+  key,
+  explorer,
+  globalConfigStore,
+  projectRoot,
+  env
+}) {
+  let merged = await getMergedConfig({
+    explorer,
+    globalConfigStore,
+    projectRoot,
+    env
+  });
+  return merged.sources[key] || 'unknown';
+}

package/dist/index.js

@@ -15,9 +15,9 @@ export { UploadError } from './errors/vizzly-error.js';
 // Primary SDK export
 export { createVizzly } from './sdk/index.js';
 export { createServices } from './services/index.js';
-export { createTDDService } from './services/tdd-service.js';
 // Core services (for advanced usage)
 export { createUploader } from './services/uploader.js';
+export { createTDDService } from './tdd/tdd-service.js';
 // Configuration helper
 export { defineConfig } from './utils/config-helpers.js';
 // Utilities

package/dist/project/core.js

@@ -0,0 +1,295 @@
+/**
+ * Project Core - Pure functions for project logic
+ *
+ * No I/O, no side effects - just data transformations.
+ */
+
+import { VizzlyError } from '../errors/vizzly-error.js';
+
+// ============================================================================
+// Validation
+// ============================================================================
+
+/**
+ * Validate that a directory path is provided
+ * @param {string} directory - Directory path to validate
+ * @returns {{ valid: boolean, error: Error|null }}
+ */
+export function validateDirectory(directory) {
+  if (!directory) {
+    return {
+      valid: false,
+      error: new VizzlyError('Directory path is required', 'INVALID_DIRECTORY')
+    };
+  }
+  return {
+    valid: true,
+    error: null
+  };
+}
+
+/**
+ * Validate project data for mapping creation
+ * @param {Object} projectData - Project data to validate
+ * @param {string} [projectData.projectSlug] - Project slug
+ * @param {string} [projectData.organizationSlug] - Organization slug
+ * @param {string} [projectData.token] - Project token
+ * @returns {{ valid: boolean, error: Error|null }}
+ */
+export function validateProjectData(projectData) {
+  if (!projectData.projectSlug) {
+    return {
+      valid: false,
+      error: new VizzlyError('Project slug is required', 'INVALID_PROJECT_DATA')
+    };
+  }
+  if (!projectData.organizationSlug) {
+    return {
+      valid: false,
+      error: new VizzlyError('Organization slug is required', 'INVALID_PROJECT_DATA')
+    };
+  }
+  if (!projectData.token) {
+    return {
+      valid: false,
+      error: new VizzlyError('Project token is required', 'INVALID_PROJECT_DATA')
+    };
+  }
+  return {
+    valid: true,
+    error: null
+  };
+}
+
+// ============================================================================
+// Mapping Transformations
+// ============================================================================
+
+/**
+ * Convert mappings object to array with directory paths included
+ * @param {Object} mappings - Object with directory paths as keys
+ * @returns {Array<Object>} Array of mappings with directory property
+ */
+export function mappingsToArray(mappings) {
+  return Object.entries(mappings).map(([directory, data]) => ({
+    directory,
+    ...data
+  }));
+}
+
+/**
+ * Build a mapping result object
+ * @param {string} directory - Directory path
+ * @param {Object} projectData - Project data
+ * @returns {Object} Mapping result with directory included
+ */
+export function buildMappingResult(directory, projectData) {
+  return {
+    directory,
+    ...projectData
+  };
+}
+
+// ============================================================================
+// API Request Helpers
+// ============================================================================
+
+/**
+ * Build query params for builds API request
+ * @param {Object} options - Query options
+ * @param {number} [options.limit] - Number of builds to fetch
+ * @param {string} [options.branch] - Filter by branch
+ * @returns {string} Query string (empty string if no params)
+ */
+export function buildBuildsQueryParams(options = {}) {
+  let params = new globalThis.URLSearchParams();
+  if (options.limit) {
+    params.append('limit', String(options.limit));
+  }
+  if (options.branch) {
+    params.append('branch', options.branch);
+  }
+  let query = params.toString();
+  return query ? `?${query}` : '';
+}
+
+/**
+ * Build organization header object
+ * @param {string} organizationSlug - Organization slug
+ * @returns {Object} Headers object with X-Organization header
+ */
+export function buildOrgHeader(organizationSlug) {
+  return {
+    'X-Organization': organizationSlug
+  };
+}
+
+/**
+ * Build API URL for project endpoint
+ * @param {string} projectSlug - Project slug
+ * @returns {string} API URL path
+ */
+export function buildProjectUrl(projectSlug) {
+  return `/api/project/${projectSlug}`;
+}
+
+/**
+ * Build API URL for builds endpoint
+ * @param {string} projectSlug - Project slug
+ * @param {Object} options - Query options
+ * @returns {string} Full API URL path with query params
+ */
+export function buildBuildsUrl(projectSlug, options = {}) {
+  let queryString = buildBuildsQueryParams(options);
+  return `/api/build/${projectSlug}${queryString}`;
+}
+
+/**
+ * Build API URL for project tokens endpoint
+ * @param {string} organizationSlug - Organization slug
+ * @param {string} projectSlug - Project slug
+ * @param {string} [tokenId] - Optional token ID for specific token operations
+ * @returns {string} API URL path
+ */
+export function buildTokensUrl(organizationSlug, projectSlug, tokenId) {
+  let base = `/api/cli/organizations/${organizationSlug}/projects/${projectSlug}/tokens`;
+  return tokenId ? `${base}/${tokenId}` : base;
+}
+
+// ============================================================================
+// Response Extraction
+// ============================================================================
+
+/**
+ * Extract projects from API response
+ * @param {Object} response - API response
+ * @returns {Array} Array of projects
+ */
+export function extractProjects(response) {
+  return response?.projects || [];
+}
+
+/**
+ * Extract project from API response
+ * @param {Object} response - API response
+ * @returns {Object} Project object
+ */
+export function extractProject(response) {
+  return response?.project || response;
+}
+
+/**
+ * Extract builds from API response
+ * @param {Object} response - API response
+ * @returns {Array} Array of builds
+ */
+export function extractBuilds(response) {
+  return response?.builds || [];
+}
+
+/**
+ * Extract token from API response
+ * @param {Object} response - API response
+ * @returns {Object} Token object
+ */
+export function extractToken(response) {
+  return response?.token;
+}
+
+/**
+ * Extract tokens from API response
+ * @param {Object} response - API response
+ * @returns {Array} Array of tokens
+ */
+export function extractTokens(response) {
+  return response?.tokens || [];
+}
+
+/**
+ * Enrich projects with organization info
+ * @param {Array} projects - Array of projects
+ * @param {Object} org - Organization object
+ * @param {string} org.slug - Organization slug
+ * @param {string} org.name - Organization name
+ * @returns {Array} Projects with organization info added
+ */
+export function enrichProjectsWithOrg(projects, org) {
+  return projects.map(project => ({
+    ...project,
+    organizationSlug: org.slug,
+    organizationName: org.name
+  }));
+}
+
+/**
+ * Extract organizations from whoami response
+ * @param {Object} whoamiResponse - Whoami API response
+ * @returns {Array} Array of organizations
+ */
+export function extractOrganizations(whoamiResponse) {
+  return whoamiResponse?.organizations || [];
+}
+
+// ============================================================================
+// Error Building
+// ============================================================================
+
+/**
+ * Build error for project fetch failure
+ * @param {Error} originalError - Original error
+ * @returns {VizzlyError} Wrapped error
+ */
+export function buildProjectFetchError(originalError) {
+  return new VizzlyError(`Failed to fetch project: ${originalError.message}`, 'PROJECT_FETCH_FAILED', {
+    originalError
+  });
+}
+
+/**
+ * Build error for no authentication available
+ * @returns {VizzlyError} No auth error
+ */
+export function buildNoAuthError() {
+  return new VizzlyError('No authentication available', 'NO_AUTH_SERVICE');
+}
+
+/**
+ * Build error for no API service available
+ * @returns {VizzlyError} No API service error
+ */
+export function buildNoApiServiceError() {
+  return new VizzlyError('API service not available', 'NO_API_SERVICE');
+}
+
+/**
+ * Build error for token creation failure
+ * @param {Error} originalError - Original error
+ * @returns {VizzlyError} Wrapped error
+ */
+export function buildTokenCreateError(originalError) {
+  return new VizzlyError(`Failed to create project token: ${originalError.message}`, 'TOKEN_CREATE_FAILED', {
+    originalError
+  });
+}
+
+/**
+ * Build error for token fetch failure
+ * @param {Error} originalError - Original error
+ * @returns {VizzlyError} Wrapped error
+ */
+export function buildTokensFetchError(originalError) {
+  return new VizzlyError(`Failed to fetch project tokens: ${originalError.message}`, 'TOKENS_FETCH_FAILED', {
+    originalError
+  });
+}
+
+/**
+ * Build error for token revoke failure
+ * @param {Error} originalError - Original error
+ * @returns {VizzlyError} Wrapped error
+ */
+export function buildTokenRevokeError(originalError) {
+  return new VizzlyError(`Failed to revoke project token: ${originalError.message}`, 'TOKEN_REVOKE_FAILED', {
+    originalError
+  });
+}

package/dist/project/index.js

@@ -0,0 +1,13 @@
+/**
+ * Project Module - Public exports
+ *
+ * Provides functional project management primitives:
+ * - core.js: Pure functions for validation, URL building, response extraction
+ * - operations.js: Project operations with dependency injection
+ */
+
+// Core pure functions
+export { buildBuildsQueryParams, buildBuildsUrl, buildMappingResult, buildNoApiServiceError, buildNoAuthError, buildOrgHeader, buildProjectFetchError, buildProjectUrl, buildTokenCreateError, buildTokenRevokeError, buildTokensFetchError, buildTokensUrl, enrichProjectsWithOrg, extractBuilds, extractOrganizations, extractProject, extractProjects, extractToken, extractTokens, mappingsToArray, validateDirectory, validateProjectData } from './core.js';
+
+// Project operations (take dependencies as parameters)
+export { createMapping, createProjectToken, getMapping, getProject, getProjectWithApiToken, getProjectWithOAuth, getRecentBuilds, getRecentBuildsWithApiToken, getRecentBuildsWithOAuth, listMappings, listProjects, listProjectsWithApiToken, listProjectsWithOAuth, listProjectTokens, removeMapping, revokeProjectToken, switchProject } from './operations.js';