@optimizely/ocp-local-env 1.0.0-beta.4

package/README.md

@@ -0,0 +1,165 @@
+# OCP Local Testing Tool
+
+A comprehensive local development and testing environment for Optimizely Connect Platform (OCP) applications.
+
+## Overview
+
+The OCP Local Testing Tool enables developers to build, test, and debug OCP applications locally before publishing them to the Optimizely Connect Platform. It provides a simulated OCP environment with real-time code reloading, interactive testing interfaces, and detailed logging.
+
+## Features
+
+- **Local OCP Environment**: Run your OCP apps locally without deploying to the cloud
+- **Real-time Code Reloading**: Changes to your app code are detected and automatically rebuilt
+- **Interactive UI**: Test functions, jobs, and lifecycle hooks through an intuitive web interface
+- **Configurable Settings**: Simulate different app configurations with a dynamic settings interface
+- **Detailed Logging**: View comprehensive logs for all app activities
+- **Webhook Testing**: Test webhook functions with customizable payloads
+- **Job Simulation**: Manually trigger jobs or simulate scheduled execution
+- **Lifecycle Testing**: Test install, upgrade, and uninstall hooks
+
+## Prerequisites
+
+- Node.js v14 or later
+- Yarn or npm
+- Modern web browser (Chrome, Firefox, Edge, or Safari)
+
+## Installation
+
+```bash
+# Install the OCP Local Testing Tool globally
+npm install -g @optimizely/ocp-local-env
+```
+
+If you run nodeJS with `nvm`, you can just run `ocp-local-env` command in your terminal. You will need to run `npm install -g @optimizely/ocp-local-env` command for every node version you are using. 
+
+If you are not using `nvm`, you might need to add the output of `npm bin -g` command to your `PATH` environment variable, open you terminal and then run `ocp-local-env` command. 
+
+## Quick Start
+
+1. Navigate to your OCP app directory (containing app.yml)
+2. Run the local testing tool
+   ```bash
+   ocp-local-env
+   ```
+3. The tool will automatically open your browser to http://localhost:3000
+4. Start developing and testing your OCP app
+
+## Configuration
+
+The OCP Local Testing Tool can be configured through environment variables and configuration files.
+
+### Environment Variables
+
+Create a `.env.local` file in your project root to configure the tool:
+
+```bash
+# Copy the example file
+cp .env.example .env.local
+```
+
+Available configuration options:
+
+- `APP_ROOT_DIR`: Root directory for the OCP app (default: current directory)
+- `OCP_LOCAL_PORT`: Port to run the server on (default: 3000)
+- `OCP_LOCAL_VERBOSE`: Enable verbose logging (default: false)
+
+### Command Line Options
+
+The `ocp-local-env` command supports several options:
+
+```bash
+ocp-local-env [options]
+
+Options:
+  -p, --port <port>    Port to run the server on (default: 3000)
+  -c, --config <path>  Path to custom config file
+  --path <path>        Path to the OCP app root directory
+  -v, --verbose        Enable verbose logging
+  --no-open           Don't automatically open browser
+  -h, --help           Display help for command
+```
+
+You can also use the explicit `start` command:
+
+```bash
+ocp-local-env start [options]
+```
+
+### Examples
+
+```bash
+# Start with a specific app directory
+ocp-local-env --path /path/to/my-ocp-app
+
+# Start on a different port
+ocp-local-env --port 8080
+
+# Enable verbose logging
+ocp-local-env --verbose
+
+# Don't open browser automatically
+ocp-local-env --no-open
+
+# Combine options
+ocp-local-env --path /path/to/my-ocp-app --port 8080 --verbose
+```
+
+## Documentation
+
+For detailed documentation, see the following guides:
+
+- [Design Document](docs/design-document.md) - Overall architecture and design
+- [Technical Specifications](docs/technical-specifications.md) - Detailed implementation specifications
+- [Usage Guide](docs/usage-guide.md) - How to use the OCP Local Testing Tool
+- [Project Structure](docs/project-structure.md) - Code organization and architecture
+- [Implementation Plan](docs/implementation-plan.md) - Phased approach to building the tool
+
+## Development
+
+### Setting Up the Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/optimizely/ocp-local-env.git
+cd ocp-local-env
+
+# Crate .env.local file and set `APP_ROOT_DIR` variable - this should be the full path to the app directory you want to test
+cp .env.example .env.local
+
+# Install dependencies
+yarn install
+
+# Build the project
+yarn build
+
+# Start the development server
+yarn dev
+```
+
+### Project Structure
+
+The project follows a modular structure with clear separation of concerns:
+
+- `src/server`: Server-side code for simulating the OCP platform
+- `src/ui`: React-based user interface
+- `src/executor`: Code execution and file watching
+- `docs`: Documentation files
+
+For more details, see the [Project Structure](docs/project-structure.md) document.
+
+## Contributing
+
+Contributions are welcome! Please read the [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+
+## Support
+
+For support, please create an issue on the [GitHub repository](https://github.com/optimizely/ocp-local-env/issues) or contact the Optimizely Connect Platform team.
+
+## Acknowledgements
+
+- Optimizely Connect Platform Team
+- OCP App Developers Community

package/dist/package.json

@@ -0,0 +1,104 @@
+{
+    "name": "@optimizely/ocp-local-env",
+    "version": "1.0.0-beta.4",
+    "description": "Local testing environment for Optimizely Connect Platform (OCP) applications",
+    "main": "dist/src/index.js",
+    "types": "dist/src/index.d.ts",
+    "bin": {
+        "ocp-local-env": "dist/src/cli.js"
+    },
+    "files": [
+        "dist/"
+    ],
+    "scripts": {
+        "build": "tsc && webpack --mode production",
+        "dev": "concurrently \"tsc --watch\" \"webpack --mode development --watch\" \"nodemon dist/src/server.js\"",
+        "dev:server": "tsc --watch && nodemon dist/src/server.js",
+        "dev:ui": "webpack --mode development --watch",
+        "start": "node dist/src/server.js",
+        "test": "jest",
+        "lint": "npx eslint 'src/**'",
+        "format": "prettier --write \"src/**/*.{ts,tsx}\"",
+        "prepare": "npm run build",
+        "release": "release-it"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/ZaiusInc/ocp-local-env.git"
+    },
+    "keywords": [
+        "optimizely",
+        "ocp",
+        "local",
+        "development",
+        "testing"
+    ],
+    "author": "Optimizely",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/optimizelyZaiusInc/ocp-local-env/issues"
+    },
+    "homepage": "https://github.com/ZaiusInc/ocp-local-env#readme",
+    "dependencies": {
+        "@zaiusinc/app-sdk": "^2.2.1",
+        "@zaiusinc/node-sdk": "^2.0.0",
+        "chalk": "^4.1.2",
+        "chokidar": "^3.5.3",
+        "commander": "^9.4.1",
+        "dotenv": "^17.2.1",
+        "express": "^4.18.2",
+        "http-proxy-middleware": "^3.0.5",
+        "js-yaml": "^4.1.0",
+        "open": "^8.4.2",
+        "react": ">=17.0.0",
+        "react-dom": ">=17.0.0",
+        "uuid": "^9.0.0"
+    },
+    "devDependencies": {
+        "@types/express": "^4.17.23",
+        "@types/jest": "^29.2.5",
+        "@types/js-yaml": "^4.0.9",
+        "@types/node": "^18.19.122",
+        "@types/react": "^18.3.23",
+        "@types/react-dom": "^18.3.7",
+        "@types/uuid": "^9.0.0",
+        "@typescript-eslint/eslint-plugin": "^5.48.0",
+        "@typescript-eslint/parser": "^5.48.0",
+        "concurrently": "^7.6.0",
+        "css-loader": "^6.7.3",
+        "eslint": "^8.31.0",
+        "eslint-config-prettier": "^8.6.0",
+        "eslint-plugin-react": "^7.31.11",
+        "html-webpack-plugin": "^5.5.0",
+        "husky": "^8.0.3",
+        "jest": "^29.3.1",
+        "lint-staged": "^16.2.0",
+        "nodemon": "^3.1.10",
+        "parse-path": "^7.0.0",
+        "prettier": "^2.8.1",
+        "release-it": "^19.0.5",
+        "style-loader": "^3.3.1",
+        "ts-jest": "^29.0.3",
+        "ts-loader": "^9.4.2",
+        "typescript": "^4.9.4",
+        "webpack": "^5.75.0",
+        "webpack-cli": "^5.0.1"
+    },
+    "peerDependencies": {
+        "react": ">=17.0.0",
+        "react-dom": ">=17.0.0"
+    },
+    "engines": {
+        "node": ">=14.0.0"
+    },
+    "lint-staged": {
+        "*.{ts,tsx}": [
+            "eslint --fix",
+            "prettier --write"
+        ]
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org",
+        "access": "public"
+    }
+}