systemlink-cli 1.3.1__tar.gz

systemlink_cli-1.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 National Instruments
+
+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.

systemlink_cli-1.3.1/PKG-INFO

@@ -0,0 +1,20 @@
+Metadata-Version: 2.4
+Name: systemlink-cli
+Version: 1.3.1
+Summary: SystemLink Integrator CLI - cross-platform CLI for SystemLink workflows and templates.
+License-File: LICENSE
+Author: Fred Visser
+Author-email: fred.visser@emerson.com
+Requires-Python: >=3.11.1,<3.15
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: click (>=7.1.2)
+Requires-Dist: keyring (>=25.6.0,<26.0.0)
+Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
+Requires-Dist: questionary (>=2.1.1,<3.0.0)
+Requires-Dist: requests (>=2.32.4,<3.0.0)
+Requires-Dist: tabulate (>=0.10.0,<0.11.0)
+Requires-Dist: truststore (>=0.9,<0.11)
+Requires-Dist: watchdog (>=6.0.0,<7.0.0)

systemlink_cli-1.3.1/dff-editor/README.md

@@ -0,0 +1,182 @@
+# Custom Fields Editor
+
+This directory contains a standalone web editor for SystemLink Custom Fields configurations with a VS Code-like interface.
+
+## Files
+
+- index.html - The main editor interface
+- editor.js - Editor JavaScript logic
+- README.md - This file
+- index.html.backup - Backup of original simple editor
+
+## Usage
+
+1. Start the editor server:
+
+```bash
+slcli customfield edit --port 8080
+```
+
+2. Open your browser to: http://localhost:8080
+
+3. Use the visual editor to build and manage your configuration
+
+4. Click "Apply to Server" when ready to save
+
+## Features
+
+### Monaco Editor
+
+- Syntax highlighting and IntelliSense for JSON
+- Real-time validation against custom fields schema
+- Auto-formatting (Alt+F) and validate (Alt+V)
+- Find/Replace (Ctrl+F / Ctrl+H)
+- Minimap, dark theme, format on paste/type
+- Auto-save every 30 seconds to local storage
+
+### Configuration Tree View
+
+- Root configuration, configurations, groups, fields
+- Counts for groups/fields; required field indicator
+- Click to navigate
+
+### Add New Items
+
+- Add Configuration: name, workspace, resource type, group keys
+- Add Group: key, name, display text, field keys (with duplicate key guard)
+- Add Field: key, name, display text, type, required (with duplicate key guard)
+- Templates with inline help and validation
+
+### Validation
+
+- JSON syntax correctness
+- Required fields present
+- Unique keys for groups/fields
+- Reference checks (configs → groups, groups → fields)
+- Enum validation (resourceType, fieldType)
+- Schema compliance
+
+### Server Integration
+
+- **Load from Server**: Fetch configurations by ID or list all configurations
+- **Apply to Server**: Seamlessly creates new or updates existing configurations
+  - **New configurations** (no ID): Automatically calls create endpoint and saves returned ID
+  - **Existing configurations** (has ID): Updates configuration on server
+  - Automatically detects operation type and uses appropriate endpoint
+- **Smart ID tracking**: After creating a config, the ID is saved to metadata and injected into the editor
+- Confirmation dialog before apply with operation-specific messaging
+- Error handling with clear messages
+- Metadata persistence: `.editor-metadata.json` tracks configuration IDs for seamless workflows
+
+### Keyboard Shortcuts
+
+- Alt+F: Format document
+- Alt+V: Validate document
+- Ctrl/Cmd+S: Save to server
+- Ctrl+F: Find
+- Ctrl+H: Find and replace
+
+### Persistence & Safety
+
+- Auto-save to localStorage every 30 seconds
+- Auto-recovery prompt for drafts <24h old
+- Unsaved changes warning on navigation
+- Download JSON export
+
+### Toolbar Actions
+
+- Format, Validate, Load Example, Download JSON, Reset
+
+## Configuration Structure
+
+### Configurations
+
+```json
+{
+  "name": "Work Order Configuration",
+  "workspace": "workspace-id",
+  "resourceType": "workorder:workorder",
+  "groupKeys": ["group1", "group2"],
+  "properties": {}
+}
+```
+
+Resource types: workorder:workorder, workitem:workitem, asset:asset, system:system, testmonitor:product
+
+Note: workorder:testplan has been replaced by workitem:workitem to align with the current API.
+
+### Groups
+
+```json
+{
+  "key": "basicInfo",
+  "workspace": "workspace-id",
+  "name": "Basic Information",
+  "displayText": "Basic Information",
+  "fieldKeys": ["field1", "field2"],
+  "properties": {}
+}
+```
+
+### Fields
+
+```json
+{
+  "key": "deviceId",
+  "workspace": "workspace-id",
+  "name": "Device ID",
+  "displayText": "Device Identifier",
+  "fieldType": "STRING",
+  "required": true,
+  "validation": { "maxLength": 50 },
+  "properties": {}
+}
+```
+
+Field types: STRING, NUMBER, BOOLEAN, DATE, DATETIME, SELECT, MULTISELECT
+Validation options: STRING (minLength, maxLength, pattern), NUMBER (min, max, step), DATE/DATETIME (min, max), SELECT/MULTISELECT (options)
+
+## Example Workflow
+
+1. Load example or start empty
+2. Add configuration (resource type)
+3. Add groups
+4. Add fields
+5. Link fields to groups via fieldKeys
+6. Link groups to configuration via groupKeys
+7. Validate
+8. Apply to server (automatically creates new or updates existing configuration)
+9. Configuration ID is saved automatically for future updates
+
+## Technical Details
+
+- Monaco Editor 0.45.0 via CDN
+- Pure vanilla JS; no build step
+- Uses fetch for API calls; localStorage for drafts
+- Customize `serverUrl`, schema, and templates in editor.js
+- Smart create/update detection based on configuration ID presence
+- Metadata tracking in `.editor-metadata.json` for seamless workflows
+
+## Troubleshooting
+
+- Editor not loading: check console/CDN access
+- Validation errors: ensure unique keys and valid references
+- Server issues: check port, CORS, network tab
+- Auto-save: ensure localStorage is available
+
+## Future Enhancements
+
+- Drag-and-drop reordering
+- Visual preview
+- Diff view (local vs server)
+- Undo/redo history
+- Import from file
+- Field/group duplication
+- Bulk operations
+- Search/filter in tree
+- Theme toggle
+- Version history
+
+---
+
+Version: 2.1 | Updated: January 8, 2026