MaconomyCSharpClassGenerator

MaconomyCSharpClassGenerator is a Visual Studio Code extension that bundles the Voldelig CLI and wraps it in an approachable UI. It helps Maconomy developers generate strongly typed C# container models that are ready to use with the VoliNuget package.

Features

• Launches the Voldelig CLI directly from VS Code – no terminal required.
• Collects all required connection, container, and output parameters through a guided form.
• Fetches available fields for a container so you can preview metadata, inspect enums, and choose the subset to generate.
• Generates classes either to disk or as a dry run (stdout) and automatically copies results to the clipboard.
• Supports bundled CLI binaries for Windows, macOS (Intel/Apple Silicon) and Linux.

Prerequisites

• A Maconomy environment with API access.
• Valid Maconomy credentials or a configuration JSON file containing connection details.
• .NET runtime is not required at runtime; the Voldelig CLI is shipped as a self-contained binary.

Getting Started

1. Install the MaconomyCSharpClassGenerator extension in VS Code.
2. Open the command palette (Ctrl+Shift+P / Cmd+Shift+P) and run “Open Maconomy C# Class Generator”.
3. The control panel webview will appear with all tooling embedded.

Using the Control Panel

Required Inputs

• Container – Maconomy container identifier (e.g., jobregistration). This is mandatory for every operation.
• Object Type – Choose between table, filter, or card (defaults to table).

Connection Details

You can provide credentials manually or load them from a JSON config file. When a config file is selected, the URL, short name, username, and password fields become optional.

{
  "baseUrl": "https://maconomy.example.com",
  "shortName": "MAC",
  "username": "maconomy-user",
  "password": "secret"
}

Use the Browse... button beside the config input to pick a file from your workspace or filesystem.

Output Options

• Output path – Optional path where the generated class will be written. Leave blank when using dry run.
• Namespace / Class name – Optional overrides for the generated types.
• Dry run – Enabled by default. When checked, generated code is printed to stdout and copied to your clipboard instead of writing to disk.

Working with Fields

1. Click Load Fields after supplying connection information. The extension runs VoldeligCLI fields --json behind the scenes and shows the results in an interactive grid.
2. Review the metadata (type, key status, enum usage, required attributes) for each field.
3. Click Select All or manually toggle checkboxes to choose the fields you want in the generated class.
4. Use Generate Selected Fields to build a C# class from the current selection, or Generate All Fields to generate without filtering.

Both generation actions copy the CLI stdout to the clipboard and display it in the panel output area. If an output path is supplied and dry run is disabled, the file is also written to disk.

Commands

The extension registers no additional settings. All behavior is configured inside the panel itself.

Troubleshooting

• No fields returned: Ensure the container ID and object type are valid in the target Maconomy environment and that the supplied credentials have access.
• Authentication errors: Verify the config file values or manual credentials. The CLI requires HTTPS endpoints and responds with detailed errors that appear in the output area.
• Binary execution issues: The extension resolves bundled binaries per platform. If custom environments block execution, review the VS Code developer console for more details.

Development Notes

• The extension bundles the Voldelig CLI under resources/cli/<runtime>. Use npm run build:cli to regenerate binaries from the sibling VoldeligCLI project.
• npm run compile transpiles TypeScript sources to out/. The extension is activated only through the maconomyCSharpClassGenerator.openPanel command.

License

This project inherits its license from the root repository. Consult LICENSE for full terms.