citadel_cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 James Childers
+
+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.

package/README.md

@@ -0,0 +1,337 @@
+# Citadel
+
+A hierarchical command-line interface (CLI) for web applications.
+
+## Quick Start
+
+```typescript
+import { Citadel, CommandTrie } from 'citadel';
+
+// Initialize command system
+const commands = new CommandTrie();
+
+// Register commands
+commands.addCommand(
+  ['customer', 'search'],
+  'Search for customer records',
+  async (args) => ({
+    json: await customerService.search(args.query)
+  }),
+  { name: 'query', description: 'Customer name or ID' }
+);
+
+// Mount in your React app
+function App() {
+  return (
+    <div>
+      <Citadel commands={commands} />
+      {/* Your app content */}
+    </div>
+  );
+}
+```
+
+## Command Usage
+
+Citadel commands composed of one or more words followed by zero or one arguments. For example:
+```
+> ticket new customer 1234
+```
+Where the user typed "tnc1234" to achieve the above result.
+
+
+### Quick Execution
+
+Commands can be typed using abbreviated forms. For example:
+```
+ticket new   →  tn
+deploy status  →  ds
+customer history  →  ch
+```
+
+Simply type the first letter of each word in the command and press Enter. 
+
+### Arguments
+
+Commands can have zero or more arguments.
+
+```bash
+> ticket new customer 1234 
+```
+
+### JavaScript Integration
+
+Commands can execute any JavaScript code, making them powerful automation tools:
+
+```typescript
+commands.addCommand(
+  ['refresh', 'cache'],
+  'Refresh application cache',
+  async () => {
+    // Clear local storage
+    localStorage.clear();
+    // Reset Redux store
+    store.dispatch(resetState());
+    // Reload application
+    window.location.reload();
+    return { json: { status: 'Cache cleared' } };
+  }
+);
+```
+
+### Dynamic Results
+
+Commands can return different types of results:
+- JSON data for structured information
+- React components for rich visualizations
+- Plain text for simple outputs
+- Promises for async operations
+
+```typescript
+commands.addCommand(
+  ['user', 'activity'],
+  'Show user activity',
+  async (args) => ({
+    // Return both data and visualization
+    json: await getUserActivity(args.userId),
+    component: <ActivityGraph userId={args.userId} />
+  })
+);
+```
+
+## Real-World Examples
+
+### Customer Service Application
+
+```typescript
+// Customer service command configuration
+commands.addCommand(
+  ['ticket', 'new'],
+  'Create support ticket',
+  async (args) => {
+    const ticket = await ticketService.create({
+      customerId: args.customer,
+      priority: args.priority,
+      description: args.description
+    });
+    return { json: { ticketId: ticket.id, status: 'created' } };
+  },
+  [
+    { name: 'customer', description: 'Customer ID' },
+    { name: 'priority', description: 'Ticket priority (high|medium|low)' },
+    { name: 'description', description: 'Issue description' }
+  ]
+);
+
+commands.addCommand(
+  ['customer', 'history'],
+  'View customer interaction history',
+  async (args) => ({
+    json: await customerService.getHistory(args.id, {
+      last: args.days || 30
+    })
+  }),
+  [
+    { name: 'id', description: 'Customer ID' },
+    { name: 'days', description: 'Number of days (default: 30)' }
+  ]
+);
+```
+
+### Trading Platform Integration
+
+```typescript
+// Trading command configuration
+commands.addCommand(
+  ['trade', 'limit'],
+  'Place limit order',
+  async (args) => {
+    const order = await tradingService.placeLimitOrder({
+      pair: args.pair,
+      price: args.price,
+      quantity: args.quantity,
+      side: args.side || 'buy'
+    });
+    return { json: { orderId: order.id, status: order.status } };
+  },
+  [
+    { name: 'pair', description: 'Trading pair (e.g., btc-usd)' },
+    { name: 'price', description: 'Limit price' },
+    { name: 'quantity', description: 'Order quantity' },
+    { name: 'side', description: 'Order side (buy|sell)' }
+  ]
+);
+```
+
+### DevOps Dashboard Commands
+
+```typescript
+// Deployment command configuration
+commands.addCommand(
+  ['deploy', 'status'],
+  'Check deployment status',
+  async (args) => ({
+    json: await deploymentService.getStatus(args.service, args.environment)
+  }),
+  [
+    { name: 'service', description: 'Service name' },
+    { name: 'environment', description: 'Environment (dev|staging|prod)' }
+  ]
+);
+
+commands.addCommand(
+  ['metrics', 'alert'],
+  'Configure service alerts',
+  async (args) => ({
+    json: await metricsService.setAlert(args.service, {
+      metric: args.metric,
+      threshold: args.threshold,
+      duration: args.duration
+    })
+  }),
+  [
+    { name: 'service', description: 'Service name' },
+    { name: 'metric', description: 'Metric name (cpu|memory|latency)' },
+    { name: 'threshold', description: 'Alert threshold' },
+    { name: 'duration', description: 'Duration in minutes' }
+  ]
+);
+```
+
+## Advanced Configuration
+
+### Custom Command Rendering
+
+Citadel supports custom rendering of command results:
+
+```typescript
+commands.addCommand(
+  ['dashboard', 'metrics'],
+  'Show service metrics',
+  async (args) => ({
+    component: <MetricsVisualization serviceId={args.service} />,
+    json: await metricsService.get(args.service)
+  }),
+  { name: 'service', description: 'Service ID' }
+);
+```
+
+### Authentication Integration
+
+```typescript
+const citadelConfig = {
+  commandFilter: (command) => {
+    const userPermissions = getUserPermissions();
+    return command.requiredPermissions.every(
+      (perm) => userPermissions.includes(perm)
+    );
+  },
+  // ... other config
+};
+```
+
+## Development
+
+### Project Structure
+```
+citadel/
+├── src/
+│   ├── components/    # React components
+│   ├── styles/        # CSS and theme files
+│   ├── types/         # TypeScript definitions
+│   └── utils/         # Utility functions
+├── public/            # Static assets
+└── vite.config.ts     # Vite configuration
+```
+
+### Contributing
+
+Contributions are welcome.
+
+1. Clone the repository:
+```bash
+git clone https://github.com/jchilders/citadel.git
+cd citadel
+```
+
+2. Install dependencies:
+```bash
+npm install
+```
+
+3. Build the package:
+```bash
+npm run build
+```
+
+4. (Optional but recommended) Link citadel so you can import it into a parallel project
+```bash
+npm link
+```
+
+5. (Optional) From the directory of the project you want to import Citadel into:
+```bash
+npm link @jchilders/citadel
+# ... your normal build/run steps ...
+```
+
+### Bug Reports and Feature Requests
+
+- Use the GitHub Issues section to report bugs or suggest features
+- Before creating a new issue, please check if a similar issue already exists
+- Provide as much detail as possible in bug reports:
+  - Steps to reproduce the issue
+  - Expected behavior
+  - Actual behavior
+  - Browser/environment information
+  - Error messages or screenshots if applicable
+
+### Development Process
+
+1. Fork the repository
+2. Create a new branch for your feature or bugfix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   # or
+   git checkout -b fix/your-bugfix-name
+   ```
+3. Make your changes
+4. Write or update tests as needed
+5. Run the test suite to ensure everything passes:
+   ```bash
+   npm test
+   ```
+6. Commit your changes with a clear and descriptive commit message
+7. Push to your fork and submit a pull request
+
+### Pull Request Guidelines
+
+- Keep your changes focused. Submit separate pull requests for separate features/fixes
+- Follow the existing code style and conventions
+- Include tests for new functionality
+- Update documentation as needed
+- Ensure all tests pass
+- Describe your changes in detail in the pull request description
+
+### Code Style
+
+- Follow TypeScript best practices
+- Use meaningful variable and function names
+- Comment complex logic or non-obvious code
+- Keep functions focused and modular
+- Use consistent formatting (the project uses ESLint and Prettier)
+
+## License
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Citadel is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+This means you can use Citadel in your own projects (commercial or non-commercial) as long as you include the original copyright notice and license terms. The MIT License is simple and permissive, allowing you to:
+
+- Use the code commercially
+- Modify the code
+- Distribute the code
+- Use in private/closed-source projects
+
+All we ask is that you include the original license and copyright notice in any copy or substantial portion of the software.

package/dist/.vite/manifest.json

@@ -0,0 +1,12 @@
+{
+  "src/index.ts": {
+    "file": "citadel.umd.js",
+    "name": "index",
+    "src": "src/index.ts",
+    "isEntry": true
+  },
+  "style.css": {
+    "file": "citadel.css",
+    "src": "style.css"
+  }
+}

package/dist/citadel.css

@@ -0,0 +1 @@
+._container_141sr_3{position:fixed;height:var(--citadel-default-height);min-height:var(--citadel-min-height);max-height:var(--citadel-max-height);background-color:var(--citadel-bg);overflow:hidden;width:100%;box-sizing:border-box;margin:0;padding:0;bottom:0;left:0;right:0}._innerContainer_141sr_19{height:100%;width:100%;display:flex;flex-direction:column;margin:0;padding:0}._inputSection_141sr_28{border-top:1px solid var(--citadel-border);padding:1rem;margin:0;box-sizing:border-box}._resizeHandle_141sr_35{width:100%;height:6px;background:transparent;cursor:ns-resize;position:absolute;top:-3px;left:0;right:0;z-index:10;-moz-user-select:none;user-select:none;-webkit-user-select:none;pointer-events:all}._resizeHandle_141sr_35:hover{background:#ffffff1a}@keyframes _citadel_slideUp_141sr_64{0%{transform:translateY(100%)}to{transform:translateY(0)}}@keyframes _citadel_slideDown_141sr_68{0%{transform:translateY(0)}to{transform:translateY(100%)}}._citadel_slideUp_141sr_64{animation:_citadel_slideUp_141sr_64 .2s ease-out forwards}._citadel_slideDown_141sr_68{animation:_citadel_slideDown_141sr_68 .2s ease-out forwards}@keyframes _shake_e9b9w_1{0%,to{transform:translate(0)}25%{transform:translate(-4px)}75%{transform:translate(4px)}}@keyframes _flashBorder_e9b9w_1{0%,to{border-color:transparent}50%{border-color:#ef4444}}._invalidInput_e9b9w_12{animation:_shake_e9b9w_1 .2s ease-in-out,_flashBorder_e9b9w_1 .3s ease-in-out;border-width:1px;border-style:solid}