@ollie-shop/cli 0.3.4 → 1.0.1

package/src/schemas/command.schema.ts

@@ -1,644 +0,0 @@
-// Following TypeScript Discipline: Import schemas from core instead of duplicating
-import {
-  BuildStatus,
-  ComponentNameSchema,
-  ComponentSlot,
-  FunctionInvocationType,
-  FunctionNameSchema,
-  OnErrorBehavior,
-  Template,
-} from "@ollie-shop/core";
-import { z } from "zod";
-
-// Re-export schemas from core for CLI use
-export { ComponentNameSchema, FunctionNameSchema };
-
-/**
- * CLI-specific schemas (only for CLI-specific concerns)
- */
-
-/**
- * Schema for file system paths
- * @example "./src/components/header"
- * @example "/absolute/path/to/component"
- */
-export const PathSchema = z.string().min(1, "Path cannot be empty");
-
-/**
- * Schema for store identifiers
- * Must be a valid UUID v4 format
- * @example "123e4567-e89b-12d3-a456-426614174000"
- */
-export const StoreIdSchema = z.string().uuid("Invalid store ID format");
-
-/**
- * Schema for version names
- * @example "Production v2.0"
- * @example "Holiday Sale Version"
- * @minLength 1
- * @maxLength 100
- */
-export const VersionNameSchema = z
-  .string()
-  .min(1, "Version name is required")
-  .max(100, "Version name is too long (max 100 characters)");
-
-/**
- * Schema for function execution priority
- * Higher numbers execute first
- * @minimum 0
- * @maximum 100
- * @example 50 - Default priority
- * @example 90 - High priority (executes early)
- * @example 10 - Low priority (executes late)
- */
-export const PrioritySchema = z
-  .number()
-  .int("Priority must be a whole number")
-  .min(0, "Priority must be between 0 and 100")
-  .max(100, "Priority must be between 0 and 100");
-
-/**
- * Schema for URLs and URL patterns
- * Supports both full URLs and path patterns
- * @example "https://api.example.com/webhook"
- * @example "/api/cart/*"
- * @example "/*" - Matches all paths
- */
-export const UrlSchema = z
-  .string()
-  .min(1, "URL is required")
-  .refine((url) => {
-    // Allow URL patterns like /api/* or /*
-    if (url.startsWith("/")) {
-      return true;
-    }
-    // Validate full URLs
-    try {
-      const parsed = new URL(url);
-      return ["http:", "https:"].includes(parsed.protocol);
-    } catch {
-      return false;
-    }
-  }, "URL must be a valid URL or path pattern");
-
-/**
- * Schema for semantic version numbers
- * @pattern ^\d+\.\d+\.\d+$
- * @example "1.0.0"
- * @example "2.4.6"
- * @see https://semver.org/
- */
-export const SemverSchema = z
-  .string()
-  .regex(
-    /^\d+\.\d+\.\d+$/,
-    "Version must follow semantic versioning format (e.g., 1.0.0)",
-  );
-
-/**
- * Component command schemas
- */
-
-/**
- * Options for creating a new component
- * @property {string} [name] - Component name in kebab-case (e.g., "header-banner")
- * @property {"header"|"main"|"footer"|"sidebar"} [slot="main"] - Where the component renders in the checkout
- * @property {boolean} [tests=true] - Whether to generate test files
- * @property {string} [template] - Custom template to use for generation
- * @property {boolean} [interactive] - Use interactive mode with prompts
- * @example
- * // CLI usage:
- * ollieshop component create --name header-banner --slot header
- * ollieshop component create --interactive
- */
-export const ComponentCreateOptionsSchema = z
-  .object({
-    name: ComponentNameSchema.optional(), // Optional for interactive mode
-    slot: ComponentSlot.optional().default("main"),
-    tests: z.boolean().optional().default(true),
-    template: z.string().optional(),
-    interactive: z.boolean().optional(),
-  })
-  .refine((data) => data.interactive || data.name, {
-    message: "Component name is required when not in interactive mode",
-    path: ["name"],
-  });
-
-/**
- * Options for building a component
- * @property {string} [path] - Path to component directory (defaults to current directory)
- * @property {boolean} [watch=false] - Watch for file changes and rebuild automatically
- * @property {boolean} [minify=true] - Minify the output bundle
- * @property {boolean} [sourcemap=true] - Generate source maps for debugging
- * @example
- * // CLI usage:
- * ollieshop component build
- * ollieshop component build --watch
- * ollieshop component build --path ./components/header --no-minify
- */
-export const ComponentBuildOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  watch: z.boolean().optional(),
-  minify: z.boolean().optional(),
-  sourcemap: z.boolean().optional(),
-});
-
-/**
- * Options for validating a component
- * @property {string} [path] - Path to component directory (defaults to current directory)
- * @property {boolean} [strict=false] - Enable strict validation mode with additional checks
- * @property {boolean} [fix=false] - Automatically fix fixable validation issues
- * @example
- * // CLI usage:
- * ollieshop component validate
- * ollieshop component validate --strict
- * ollieshop component validate --fix
- */
-export const ComponentValidateOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  strict: z.boolean().optional(),
-  fix: z.boolean().optional(),
-});
-
-/**
- * Options for deploying a component
- * @property {string} [path] - Path to component directory (defaults to current directory)
- * @property {string} [componentId] - UUID of the component to deploy (internal use)
- * @property {string} [id] - UUID of the component to deploy (CLI flag)
- * @example
- * // CLI usage:
- * ollieshop component deploy --id 123e4567-e89b-12d3-a456-426614174000
- * ollieshop component deploy --id 123e4567-e89b-12d3-a456-426614174000 --path ./dist
- */
-export const ComponentDeployOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  componentId: z.string().uuid("Invalid component ID format").optional(),
-  id: z.string().uuid("Invalid component ID format").optional(), // CLI uses --id flag
-});
-
-/**
- * Function command schemas
- */
-
-/**
- * Options for creating a new function
- * @property {string} name - Function name in kebab-case (e.g., "validate-cart")
- * @property {"request"|"response"} [invocation="request"] - When the function executes in the request lifecycle
- * @property {number} [priority=0] - Execution priority (0-100, higher executes first)
- * @property {"throw"|"skip"} [onError="throw"] - Error handling behavior
- * @property {boolean} [tests=true] - Whether to generate test files
- * @property {string} [template] - Custom template to use for generation
- * @property {string} [description] - Human-readable description of function purpose
- * @example
- * // CLI usage:
- * ollieshop function create --name validate-cart --invocation request --priority 90
- * ollieshop function create --name apply-discount --on-error skip
- */
-export const FunctionCreateOptionsSchema = z.object({
-  name: FunctionNameSchema,
-  invocation: FunctionInvocationType.optional().default("request"),
-  priority: PrioritySchema.optional().default(0),
-  onError: OnErrorBehavior.optional().default("throw"),
-  tests: z.boolean().optional().default(true),
-  template: z.string().optional(),
-  description: z.string().optional(),
-});
-
-/**
- * Options for building a function
- * @property {string} [path] - Path to function directory (defaults to current directory)
- * @property {boolean} [watch=false] - Watch for file changes and rebuild automatically
- * @property {boolean} [minify=true] - Minify the output bundle
- * @property {"node16"|"node18"|"node20"} [target="node18"] - Target Node.js runtime version
- * @example
- * // CLI usage:
- * ollieshop function build
- * ollieshop function build --watch --target node20
- * ollieshop function build --no-minify
- */
-export const FunctionBuildOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  watch: z.boolean().optional(),
-  minify: z.boolean().optional(),
-  target: z.enum(["node16", "node18", "node20"]).optional(),
-});
-
-export const FunctionValidateOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  strict: z.boolean().optional(),
-  fix: z.boolean().optional(),
-});
-
-/**
- * Options for testing a function
- * @property {string} [path] - Path to function directory (defaults to current directory)
- * @property {string} [payload] - JSON payload to send to the function
- * @property {number} [timeout=30000] - Test timeout in milliseconds
- * @property {boolean} [coverage=false] - Generate code coverage report
- * @property {boolean} [watch=false] - Run tests in watch mode
- * @example
- * // CLI usage:
- * ollieshop function test
- * ollieshop function test --payload '{"cart": {"total": 100}}'
- * ollieshop function test --watch --coverage
- */
-export const FunctionTestOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  payload: z.string().optional(),
-  timeout: z.number().optional(),
-  coverage: z.boolean().optional(),
-  watch: z.boolean().optional(),
-});
-
-/**
- * Options for deploying a function
- * @property {string} [path] - Path to function directory (defaults to current directory)
- * @property {string} [functionId] - UUID of the function to deploy (internal use)
- * @property {string} [id] - UUID of the function to deploy (CLI flag)
- * @example
- * // CLI usage:
- * ollieshop function deploy --id 123e4567-e89b-12d3-a456-426614174000
- * ollieshop function deploy --id 123e4567-e89b-12d3-a456-426614174000 --path ./dist
- */
-export const FunctionDeployOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  functionId: z.string().uuid("Invalid function ID format").optional(),
-  id: z.string().uuid("Invalid function ID format").optional(), // CLI uses --id flag
-});
-
-/**
- * Development server schemas
- */
-
-/**
- * Options for running a development server
- * @property {number} [port=3000] - Port number to run the server on (1000-65535)
- * @property {string} [host="localhost"] - Host to bind the server to
- * @property {boolean} [open=true] - Open browser automatically when server starts
- * @property {string} [component] - Path to specific component to develop
- * @property {string} [function] - Path to specific function to develop
- * @property {string} [mockData] - Path to mock data file for testing
- * @property {boolean} [hot=true] - Enable hot module replacement
- * @property {boolean} [https=false] - Enable HTTPS with self-signed certificate
- * @example
- * // CLI usage:
- * ollieshop dev
- * ollieshop dev --port 8080 --no-open
- * ollieshop dev --component ./components/header --hot
- */
-export const DevServerOptionsSchema = z.object({
-  port: z.number().min(1000).max(65535).default(3000),
-  host: z.string().default("localhost"),
-  open: z.boolean().default(true),
-  component: PathSchema.optional(),
-  function: PathSchema.optional(),
-  mockData: PathSchema.optional(),
-  hot: z.boolean().default(true),
-  https: z.boolean().default(false),
-});
-
-/**
- * Global CLI options schemas
- */
-
-/**
- * Global options available for all CLI commands
- * @property {boolean} [verbose=false] - Show detailed output and debug information
- * @property {boolean} [quiet=false] - Suppress all output except errors
- * @property {boolean} [color=true] - Enable colored output (use --no-color to disable)
- * @property {string} [config] - Path to custom configuration file
- * @property {"error"|"warn"|"info"|"debug"} [logLevel="info"] - Minimum log level to display
- * @example
- * // CLI usage:
- * ollieshop --verbose component create --name header
- * ollieshop --quiet function deploy --id abc-123
- * ollieshop --no-color --log-level debug component build
- */
-export const GlobalOptionsSchema = z.object({
-  verbose: z.boolean().default(false),
-  quiet: z.boolean().default(false),
-  color: z.boolean().default(true), // --no-color sets this to false
-  config: PathSchema.optional(),
-  logLevel: z.enum(["error", "warn", "info", "debug"]).default("info"),
-});
-
-/**
- * Build command schemas
- */
-
-/**
- * Options for building projects, components, or functions
- * @property {string} [path] - Path to build (defaults to current directory)
- * @property {string} [output] - Output directory for build artifacts
- * @property {boolean} [minify=true] - Minify the output
- * @property {boolean} [sourcemap=true] - Generate source maps
- * @property {boolean} [watch=false] - Watch mode for continuous builds
- * @property {boolean} [clean=true] - Clean output directory before building
- * @example
- * // CLI usage:
- * ollieshop build
- * ollieshop build --output ./dist --no-minify
- * ollieshop build --watch --no-clean
- */
-export const BuildOptionsSchema = z.object({
-  path: PathSchema.optional(),
-  output: PathSchema.optional(),
-  minify: z.boolean().default(true),
-  sourcemap: z.boolean().default(true),
-  watch: z.boolean().default(false),
-  clean: z.boolean().default(true),
-});
-
-/**
- * Login/Auth schemas
- */
-
-/**
- * Options for CLI authentication
- * @property {string} [token] - Authentication token (if not using interactive login)
- * @property {boolean} [interactive=true] - Use interactive browser-based login
- * @property {boolean} [save=true] - Save credentials for future use
- * @example
- * // CLI usage:
- * ollieshop login
- * ollieshop login --token abc123
- * ollieshop login --no-save
- */
-export const LoginOptionsSchema = z.object({
-  token: z.string().optional(),
-  interactive: z.boolean().default(true),
-  save: z.boolean().default(true),
-});
-
-/**
- * Init project schemas
- */
-
-/**
- * Options for initializing a new Ollie Shop project
- * @property {string} [name="my-ollie-shop"] - Project name
- * @property {"default"|"grocery"|"sales"} [template="default"] - Checkout template to use
- * @property {boolean} [git=true] - Initialize git repository
- * @property {boolean} [install=true] - Install dependencies automatically
- * @property {string} [path] - Where to create the project (defaults to project name)
- * @example
- * // CLI usage:
- * ollieshop init --name my-checkout
- * ollieshop init --template grocery --no-install
- * ollieshop init --name holiday-sale --path ./projects/holiday
- */
-export const InitOptionsSchema = z.object({
-  name: z.string().optional(),
-  template: Template.optional().default("default"),
-  git: z.boolean().default(true),
-  install: z.boolean().default(true),
-  path: PathSchema.optional(),
-});
-
-/**
- * Store version command schemas
- */
-
-/**
- * Options for creating a store version
- * @property {string} store - UUID of the store
- * @property {string} name - Version name (1-100 characters)
- * @property {"default"|"grocery"|"sales"} [template] - Checkout template
- * @property {boolean} [active=true] - Whether version is active immediately
- * @example
- * // CLI usage:
- * ollieshop version create --store 123e4567-e89b-12d3-a456-426614174000 --name "Black Friday"
- * ollieshop version create --store abc-123 --name "Test" --template grocery --no-active
- */
-export const StoreVersionCreateOptionsSchema = z.object({
-  store: StoreIdSchema,
-  name: VersionNameSchema,
-  template: Template.optional(),
-  active: z.boolean().optional(),
-});
-
-export const StoreVersionListOptionsSchema = z.object({
-  store: StoreIdSchema,
-});
-
-export const StoreVersionCloneOptionsSchema = z.object({
-  store: StoreIdSchema,
-  sourceId: z.string().uuid("Invalid source version ID"),
-  name: VersionNameSchema,
-});
-
-export const StoreVersionActivateOptionsSchema = z.object({
-  store: StoreIdSchema,
-  versionId: z.string().uuid("Invalid version ID"),
-});
-
-export const StoreVersionSetDefaultOptionsSchema = z.object({
-  store: StoreIdSchema,
-  versionId: z.string().uuid("Invalid version ID"),
-});
-
-// Type exports
-export type ComponentCreateOptions = z.infer<
-  typeof ComponentCreateOptionsSchema
->;
-export type ComponentBuildOptions = z.infer<typeof ComponentBuildOptionsSchema>;
-export type ComponentValidateOptions = z.infer<
-  typeof ComponentValidateOptionsSchema
->;
-export type ComponentDeployOptions = z.infer<
-  typeof ComponentDeployOptionsSchema
->;
-
-export type FunctionCreateOptions = z.infer<typeof FunctionCreateOptionsSchema>;
-export type FunctionBuildOptions = z.infer<typeof FunctionBuildOptionsSchema>;
-export type FunctionValidateOptions = z.infer<
-  typeof FunctionValidateOptionsSchema
->;
-export type FunctionTestOptions = z.infer<typeof FunctionTestOptionsSchema>;
-export type FunctionDeployOptions = z.infer<typeof FunctionDeployOptionsSchema>;
-
-export type DevServerOptions = z.infer<typeof DevServerOptionsSchema>;
-export type GlobalOptions = z.infer<typeof GlobalOptionsSchema>;
-export type BuildOptions = z.infer<typeof BuildOptionsSchema>;
-export type LoginOptions = z.infer<typeof LoginOptionsSchema>;
-export type InitOptions = z.infer<typeof InitOptionsSchema>;
-
-export type StoreVersionCreateOptions = z.infer<
-  typeof StoreVersionCreateOptionsSchema
->;
-export type StoreVersionListOptions = z.infer<
-  typeof StoreVersionListOptionsSchema
->;
-export type StoreVersionCloneOptions = z.infer<
-  typeof StoreVersionCloneOptionsSchema
->;
-export type StoreVersionActivateOptions = z.infer<
-  typeof StoreVersionActivateOptionsSchema
->;
-export type StoreVersionSetDefaultOptions = z.infer<
-  typeof StoreVersionSetDefaultOptionsSchema
->;
-
-/**
- * Validation helper functions
- */
-// NOTE: For component and function name validation, use validation functions from core:
-// import { validateComponentName, validateFunctionName } from "@ollie-shop/core/schemas"
-
-export function validatePath(path: string): boolean {
-  return PathSchema.safeParse(path).success;
-}
-
-export function validateStoreId(storeId: string): boolean {
-  return StoreIdSchema.safeParse(storeId).success;
-}
-
-export function validateVersionName(name: string): boolean {
-  return VersionNameSchema.safeParse(name).success;
-}
-
-export function validatePriority(priority: number): boolean {
-  return PrioritySchema.safeParse(priority).success;
-}
-
-export function validateUrl(url: string): boolean {
-  return UrlSchema.safeParse(url).success;
-}
-
-export function validateSemver(version: string): boolean {
-  return SemverSchema.safeParse(version).success;
-}
-
-export function validateUUID(id: string): boolean {
-  const uuidSchema = z.string().uuid();
-  return uuidSchema.safeParse(id).success;
-}
-
-/**
- * Environment variable validation schemas and helpers
- */
-export const BuilderApiUrlSchema = z
-  .string()
-  .url("BUILDER_API_URL must be a valid URL")
-  .refine(
-    (url) => {
-      try {
-        const parsed = new URL(url);
-        return ["http:", "https:"].includes(parsed.protocol);
-      } catch {
-        return false;
-      }
-    },
-    {
-      message: "BUILDER_API_URL must use http or https protocol",
-    },
-  );
-
-export const EnvironmentVariablesSchema = z.object({
-  BUILDER_API_URL: BuilderApiUrlSchema.optional(),
-  DEBUG: z.string().optional(),
-  NODE_ENV: z.enum(["development", "test", "production"]).optional(),
-});
-
-/**
- * Validates all CLI environment variables
- * @returns {Object} Validation result with success flag and optional errors
- * @returns {boolean} result.success - True if all env vars are valid
- * @returns {string[]} [result.errors] - Array of validation error messages
- * @example
- * const result = validateEnvironmentVariables();
- * if (!result.success) {
- *   console.error("Invalid environment:", result.errors);
- * }
- */
-export function validateEnvironmentVariables(): {
-  success: boolean;
-  errors?: string[];
-} {
-  const envVars = {
-    BUILDER_API_URL: process.env.BUILDER_API_URL,
-    DEBUG: process.env.DEBUG,
-    NODE_ENV: process.env.NODE_ENV,
-  };
-
-  const result = EnvironmentVariablesSchema.safeParse(envVars);
-
-  if (!result.success) {
-    return {
-      success: false,
-      errors: result.error.issues.map(
-        (issue) => `${issue.path.join(".")}: ${issue.message}`,
-      ),
-    };
-  }
-
-  return { success: true };
-}
-
-export function validateBuilderApiUrl(url?: string): boolean {
-  if (!url) return true; // Optional
-  return BuilderApiUrlSchema.safeParse(url).success;
-}
-
-/**
- * CLI Data Display Schemas
- * These schemas define the structure for data displayed in CLI commands
- */
-
-// Function list item schema for CLI display
-export const FunctionListItemSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  runtime: z.string().optional(),
-  version: z.string().optional(),
-  enabled: z.boolean(),
-  createdAt: z.union([z.string(), z.date()]),
-  invocation: FunctionInvocationType.optional(),
-  priority: z.number().optional(),
-  onError: OnErrorBehavior.optional(),
-  description: z.string().optional(),
-});
-
-// Component list item schema for CLI display
-export const ComponentListItemSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  slot: ComponentSlot,
-  version: z.string().optional(),
-  enabled: z.boolean(),
-  createdAt: z.union([z.string(), z.date()]),
-  description: z.string().optional(),
-});
-
-// Build status schema
-export const BuildStatusSchema = z.object({
-  id: z.string(),
-  status: BuildStatus,
-  startTime: z.union([z.string(), z.date()]),
-  endTime: z.union([z.string(), z.date()]).optional(),
-  deploymentUrl: z.string().optional(),
-  artifactLocation: z.string().optional(),
-  logs: z.string().optional(),
-  error: z.string().optional(),
-  resourceId: z.string(),
-  resourceType: z.enum(["component", "function"]),
-});
-
-// Version list item schema for CLI display
-export const VersionListItemSchema = z.object({
-  id: z.string(),
-  name: z.string(),
-  template: z.string().nullable().optional(),
-  active: z.boolean(),
-  default: z.boolean(),
-  createdAt: z.union([z.string(), z.date()]),
-  updatedAt: z.union([z.string(), z.date()]),
-  storeId: z.string(),
-});
-
-// Type exports derived from schemas
-export type FunctionListItem = z.infer<typeof FunctionListItemSchema>;
-export type ComponentListItem = z.infer<typeof ComponentListItemSchema>;
-export type BuildStatusItem = z.infer<typeof BuildStatusSchema>;
-export type VersionListItem = z.infer<typeof VersionListItemSchema>;