@esimplicitylabs/katalyst-xspec 0.6.0

package/dist/steps/index.d.ts

@@ -0,0 +1,151 @@
+declare function registerApiHttpSteps(test: any): void;
+
+declare function registerApiAssertionSteps(test: any): void;
+
+declare function registerApiAuthSteps(test: any): void;
+
+declare function registerHybridSteps(test: any): void;
+
+declare function registerSharedCleanupSteps(test: any): void;
+
+declare function registerSharedVarSteps(test: any): void;
+
+/**
+ * Feature Flag Step Definitions
+ *
+ * Steps for managing feature flags in tests.
+ * These steps store flag state in the world object for use in other steps.
+ */
+/**
+ * Check if a feature flag is enabled.
+ * Can be used by other steps for conditional logic.
+ */
+declare function isFlagEnabled(world: any, flagName: string): boolean;
+/**
+ * Set a feature flag value.
+ * Can be used programmatically by other steps or adapters.
+ */
+declare function setFlag(world: any, flagName: string, enabled: boolean): void;
+declare function registerFlagSteps(test: any): void;
+
+declare function registerUiBasicSteps(test: any): void;
+
+declare function registerWizardSteps(test: any): void;
+
+/**
+ * UI Form Step Definitions
+ *
+ * Steps for bulk form filling using Gherkin data tables.
+ * Tagged with @ui or @hybrid for selective execution.
+ */
+declare function registerFormSteps(test: any): void;
+
+/**
+ * UI Debug Step Definitions
+ *
+ * Steps for debugging and troubleshooting UI tests.
+ * Tagged with @ui or @hybrid for selective execution.
+ */
+declare function registerDebugSteps(test: any): void;
+
+/**
+ * UI Layout Assertion Step Definitions
+ *
+ * Steps for asserting layout states like panels, split views, and responsive behavior.
+ * Tagged with @ui or @hybrid for selective execution.
+ */
+declare function registerLayoutSteps(test: any): void;
+
+/**
+ * UI Auth Step Definitions
+ *
+ * Steps for authenticating in UI tests using fetch interception.
+ * Tagged with @ui for selective execution.
+ */
+declare function registerUiAuthSteps(test: any): void;
+
+/**
+ * TUI Basic Step Definitions
+ *
+ * Basic step definitions for terminal user interface testing.
+ * Tagged with @tui for selective execution.
+ * Aligned with ui.basic.ts patterns for consistency.
+ */
+declare function registerTuiBasicSteps(test: any): void;
+
+/**
+ * TUI Wizard Step Definitions
+ *
+ * Advanced step definitions for terminal user interface testing.
+ * Tagged with @tui for selective execution.
+ * Aligned with ui.wizard.ts patterns for consistency.
+ */
+declare function registerTuiWizardSteps(test: any): void;
+
+/**
+ * Register all API step definitions.
+ * Steps are tagged with @api or @hybrid for selective execution.
+ */
+declare function registerApiSteps(test: any): void;
+/**
+ * Register all UI step definitions.
+ * Steps are tagged with @ui or @hybrid for selective execution.
+ *
+ * Includes:
+ * - Basic UI steps (navigation, clicks, fills)
+ * - Wizard steps (advanced interactions, locators, assertions)
+ * - Form steps (bulk form filling)
+ * - Debug steps (debugging utilities)
+ * - Layout steps (panel, split view, responsive assertions)
+ * - Auth steps (fetch interception auth)
+ */
+declare function registerUiSteps(test: any): void;
+/**
+ * Register shared step definitions (used by all test types).
+ *
+ * Includes:
+ * - Variable management steps
+ * - Cleanup steps
+ * - Feature flag steps
+ */
+declare function registerSharedSteps(test: any): void;
+/**
+ * Register hybrid step definitions.
+ * Steps that work with both API and UI in the same scenario.
+ */
+declare function registerHybridSuite(test: any): void;
+/**
+ * Register all TUI (Terminal User Interface) step definitions.
+ * Steps are tagged with @tui for selective execution.
+ *
+ * @example
+ * ```typescript
+ * import { createBddTest, registerTuiSteps, TuiTesterAdapter } from '@esimplicitylabs/katalyst-xspec';
+ *
+ * const test = createBddTest({
+ *   createTui: () => new TuiTesterAdapter({
+ *     command: ['node', 'dist/cli.js'],
+ *   }),
+ * });
+ *
+ * registerTuiSteps(test);
+ * ```
+ */
+declare function registerTuiSteps(test: any): void;
+/**
+ * Register all step definitions for a full-featured test suite.
+ * This is a convenience function that registers API, UI, TUI, Shared, and Hybrid steps.
+ *
+ * Note: TUI steps require the optional `tui-tester` peer dependency.
+ *
+ * @example
+ * ```typescript
+ * import { createBddTest, registerAllSteps } from '@esimplicitylabs/katalyst-xspec';
+ *
+ * const test = createBddTest({ ... });
+ * registerAllSteps(test);
+ * ```
+ */
+declare function registerAllSteps(test: any): void;
+
+export { isFlagEnabled, registerAllSteps, registerApiAssertionSteps, registerApiAuthSteps, registerApiHttpSteps, registerApiSteps, registerDebugSteps, registerFlagSteps, registerFormSteps, registerHybridSteps, registerHybridSuite, registerLayoutSteps, registerSharedCleanupSteps, registerSharedSteps, registerSharedVarSteps, registerTuiBasicSteps, registerTuiSteps, registerTuiWizardSteps, registerUiAuthSteps, registerUiBasicSteps, registerUiSteps, registerWizardSteps, setFlag };

package/dist/steps/index.js

@@ -0,0 +1,50 @@
+import {
+  isFlagEnabled,
+  registerAllSteps,
+  registerApiAssertionSteps,
+  registerApiAuthSteps,
+  registerApiHttpSteps,
+  registerApiSteps,
+  registerDebugSteps,
+  registerFlagSteps,
+  registerFormSteps,
+  registerHybridSteps,
+  registerHybridSuite,
+  registerLayoutSteps,
+  registerSharedCleanupSteps,
+  registerSharedSteps,
+  registerSharedVarSteps,
+  registerTuiBasicSteps,
+  registerTuiSteps,
+  registerTuiWizardSteps,
+  registerUiAuthSteps,
+  registerUiBasicSteps,
+  registerUiSteps,
+  registerWizardSteps,
+  setFlag
+} from "../chunk-ACAXOGKZ.js";
+export {
+  isFlagEnabled,
+  registerAllSteps,
+  registerApiAssertionSteps,
+  registerApiAuthSteps,
+  registerApiHttpSteps,
+  registerApiSteps,
+  registerDebugSteps,
+  registerFlagSteps,
+  registerFormSteps,
+  registerHybridSteps,
+  registerHybridSuite,
+  registerLayoutSteps,
+  registerSharedCleanupSteps,
+  registerSharedSteps,
+  registerSharedVarSteps,
+  registerTuiBasicSteps,
+  registerTuiSteps,
+  registerTuiWizardSteps,
+  registerUiAuthSteps,
+  registerUiBasicSteps,
+  registerUiSteps,
+  registerWizardSteps,
+  setFlag
+};

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@esimplicitylabs/katalyst-xspec",
+  "version": "0.6.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./steps": {
+      "types": "./dist/steps/index.d.ts",
+      "import": "./dist/steps/index.js",
+      "default": "./dist/steps/index.js"
+    }
+  },
+  "description": "Playwright-BDD testing framework for API/UI/hybrid/TUI: fixtures, ports, adapters, step definitions, and the katalyst-xspec CLI (init, upgrade, stubs).",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/esimplicityinc/katalyst-xspec"
+  },
+  "bugs": {
+    "url": "https://github.com/esimplicityinc/katalyst-xspec/issues"
+  },
+  "homepage": "https://github.com/esimplicityinc/katalyst-xspec",
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "Kata",
+  "keywords": [
+    "playwright",
+    "bdd",
+    "testing",
+    "cucumber",
+    "api",
+    "ui",
+    "hybrid",
+    "tui",
+    "terminal",
+    "cli"
+  ],
+  "files": [
+    "dist",
+    "bin",
+    "cli",
+    "skills",
+    "scripts"
+  ],
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist",
+    "test": "node --import tsx --test src/__tests__/*.test.ts && node --test test/*.test.cjs",
+    "postinstall": "node scripts/postinstall.cjs"
+  },
+  "peerDependencies": {
+    "@playwright/test": "^1.49.0",
+    "playwright-bdd": "^9.1.0",
+    "tui-tester": "^1.0.0",
+    "typescript": "^5.6.0"
+  },
+  "peerDependenciesMeta": {
+    "tui-tester": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^22.10.0",
+    "tsup": "^8.3.0",
+    "tsx": "^4.19.2"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "katalyst-xspec": "bin/katalyst-xspec.cjs"
+  }
+}

package/scripts/postinstall.cjs

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+'use strict';
+
+const { execSync } = require('child_process');
+
+// ANSI color codes
+const RESET = '\x1b[0m';
+const BOLD = '\x1b[1m';
+const RED = '\x1b[31m';
+const YELLOW = '\x1b[33m';
+const GREEN = '\x1b[32m';
+const CYAN = '\x1b[36m';
+const BG_YELLOW = '\x1b[43m';
+const BG_RED = '\x1b[41m';
+const BLACK = '\x1b[30m';
+
+function checkCommand(cmd) {
+  try {
+    execSync(`which ${cmd}`, { stdio: 'pipe' });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+// Strip ANSI codes for length calculation
+function stripAnsi(str) {
+  return str.replace(/\x1b\[[0-9;]*m/g, '');
+}
+
+function printBox(lines, color = YELLOW) {
+  const maxLen = Math.max(...lines.map(l => stripAnsi(l).length));
+  const border = '═'.repeat(maxLen + 2);
+  
+  console.log(`${color}╔${border}╗${RESET}`);
+  for (const line of lines) {
+    const visibleLen = stripAnsi(line).length;
+    const padding = ' '.repeat(maxLen - visibleLen);
+    console.log(`${color}║${RESET} ${line}${padding} ${color}║${RESET}`);
+  }
+  console.log(`${color}╚${border}╝${RESET}`);
+}
+
+function main() {
+  // Allow testing with --test-warning flag
+  const testWarning = process.argv.includes('--test-warning');
+  const hasTmux = testWarning ? false : checkCommand('tmux');
+  const warnings = [];
+
+  // Check for tmux (needed for TUI testing)
+  if (!hasTmux) {
+    warnings.push({
+      title: 'tmux NOT FOUND',
+      lines: [
+        `${BOLD}TUI testing requires tmux${RESET}`,
+        '',
+        'If you plan to use @tui tests, install tmux:',
+        '',
+        `  ${CYAN}macOS:${RESET}         brew install tmux`,
+        `  ${CYAN}Ubuntu/Debian:${RESET} sudo apt-get install tmux`,
+        `  ${CYAN}Fedora/RHEL:${RESET}   sudo dnf install tmux`,
+        '',
+        `${YELLOW}Skip this if you only use @api, @ui, or @hybrid tests.${RESET}`,
+      ],
+    });
+  }
+
+  // Print warnings if any
+  if (warnings.length > 0) {
+    console.log('');
+    console.log(`${BG_YELLOW}${BLACK}${BOLD} WARNING ${RESET}`);
+    console.log('');
+    
+    for (const warning of warnings) {
+      printBox(warning.lines, YELLOW);
+      console.log('');
+    }
+  }
+
+  // Always show success message
+  console.log(`${GREEN}${BOLD}@esimplicitylabs/katalyst-xspec${RESET} installed successfully!`);
+  console.log('');
+}
+
+main();