ASLM_Module.json

{
    "fileVersion": 1,
    "id": "aslm-python-example",
    "name": "Example Python Module",
    "description": "Reference ASLM Python module: Flask WebView UI, typed settings (getExec/setExec), downloads bridge (stdio JSON), host theme/locale snapshots, module interop HTTP client, and host-managed python-runtime venv.",
    "version": "1.0.0.5",
    "author": "NEXTGGTECH",
    "type": "ui",
    "category": [
        "developer-tools"
    ],
    "hasPage": true,
    "icon": "icon.png",
    "sidebarIcon": "sidebar_icon.png",
    "source": {
        "type": "github",
        "repo": "NEXTGGTECH/ASLM-Python-Example-Module"
    },
    "update": {
        "mode": "release",
        "channel": "release",
        "branch": "main",
        "preserve": [
            "Settings/settings.json"
        ],
        "runFirstRunAfterUpdate": true
    },
    "dependencies": {
        "engines": [
            {
                "id": "python-runtime",
                "libraries": [
                    "flask>=3.0"
                ]
            }
        ]
    },
    "commands": {
        "firstRun": [
            {
                "name": "Initialize settings.json",
                "description": "Creates Settings/settings.json from manifest defaults (first install or after update).",
                "engine": "python-runtime",
                "exec": "main.py first_run"
            }
        ],
        "run": [
            {
                "name": "Flask WebView server",
                "description": "Binds to example-port and serves App/ for the ASLM module page (ASLM_UI_PORT).",
                "engine": "python-runtime",
                "exec": "main.py runserver"
            }
        ]
    },
    "settings": [
        {
            "key": "example-port",
            "name": "Port number",
            "description": "TCP port for the Flask UI server; ASLM reserves it, injects ASLM_UI_PORT, and passes the value to setExec",
            "type": "port",
            "default": 20100,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-port",
            "setExec": "main.py set_setting --key example-port --value {value}"
        },
        {
            "key": "example-string",
            "name": "String value",
            "description": "Plain text stored in settings.json, exported as ASLM_EXAMPLE_STRING; shown as the greeting banner on the dashboard",
            "type": "string",
            "default": "Example Python Module - ASLM reference UI",
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-string",
            "setExec": "main.py set_setting --key example-string --value {value}"
        },
        {
            "key": "example-bool",
            "name": "Boolean value",
            "description": "ASLM passes \"true\"/\"false\" to setExec, normalised to a Python bool; when true, the dashboard shows ASLM_* env vars and raw JSON debug panels",
            "type": "bool",
            "default": true,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-bool",
            "setExec": "main.py set_setting --key example-bool --value {value}"
        },
        {
            "key": "example-int",
            "name": "Integer value",
            "description": "Whole number passed as a string to setExec and converted with int(); used as the auto-refresh interval (ms) for the Module Interop registry timer",
            "type": "int",
            "default": 10000,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-int",
            "setExec": "main.py set_setting --key example-int --value {value}"
        },
        {
            "key": "example-number",
            "name": "Float value",
            "description": "Decimal number passed to setExec and converted with float(); sampling fraction 0.0-1.0 for verbose log output in bridge and interop handlers",
            "type": "number",
            "default": 0.25,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-number",
            "setExec": "main.py set_setting --key example-number --value {value}"
        },
        {
            "key": "example-password",
            "name": "Password value",
            "description": "Masked in the ASLM UI, redacted to *** in GET /api/settings; used as a bearer token in sample HTTP client Authorization headers",
            "type": "password",
            "default": "sk-1234-5678-9012-3456-7890",
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-password",
            "setExec": "main.py set_setting --key example-password --value {value}"
        },
        {
            "key": "example-select",
            "name": "Select value",
            "description": "Enum constrained to allowedValues; controls logging.basicConfig level in main.py subcommands (basic: INFO, debug: DEBUG, trace: DEBUG + verbose)",
            "type": "select",
            "default": "debug",
            "allowedValues": [
                "basic",
                "debug",
                "trace"
            ],
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key example-select",
            "setExec": "main.py set_setting --key example-select --value {value}"
        },
        {
            "key": "python-runtime",
            "name": "Engine flag",
            "description": "Read-only flag set by ASLM; true when the python-runtime engine is installed, false when the package is missing. Key equals the engine id.",
            "type": "engine",
            "default": true,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key python-runtime",
            "setExec": "main.py set_setting --key python-runtime --value {value}"
        },
        {
            "key": "python-runtime_path",
            "name": "Path value",
            "description": "Absolute path to python.exe in the host-managed venv; ASLM auto-fills it using the key prefix convention <engineId>_path",
            "type": "path",
            "default": null,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key python-runtime_path",
            "setExec": "main.py set_setting --key python-runtime_path --value {value}"
        },
        {
            "key": "python-runtime_data",
            "name": "Data directory",
            "description": "Per-engine writable data root; ASLM auto-fills it using the key prefix convention <engineId>_data",
            "type": "data",
            "default": null,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key python-runtime_data",
            "setExec": "main.py set_setting --key python-runtime_data --value {value}"
        },
        {
            "key": "python-runtime_models",
            "name": "Models directory",
            "description": "Per-engine models directory; ASLM auto-fills it using the key prefix convention <engineId>_models",
            "type": "models",
            "default": null,
            "engine": "python-runtime",
            "getExec": "main.py get_setting --key python-runtime_models",
            "setExec": "main.py set_setting --key python-runtime_models --value {value}"
        },
        {
            "key": "example-theme",
            "name": "Host theme snapshot",
            "description": "Host-only; ASLM calls apply_aslm_host_theme --file {path}, handler saves to Settings/host_theme.json and maps colors.* to CSS variables",
            "type": "theme",
            "engine": "python-runtime",
            "setExec": "main.py apply_aslm_host_theme --file {value}"
        },
        {
            "key": "example-locale",
            "name": "Host locale snapshot",
            "description": "Host-only; ASLM calls apply_aslm_locale --file {path}, handler saves to Settings/host_locale.json; read language and displayName to localise UI strings",
            "type": "locale",
            "engine": "python-runtime",
            "setExec": "main.py apply_aslm_locale --file {value}"
        }
    ],
    "downloadsBridge": {
        "protocolVersion": 1,
        "engine": "python-runtime",
        "entryPoint": "main.py downloads_bridge",
        "operations": [
            "list_categories",
            "list_items",
            "describe_item",
            "resolve_install",
            "resolve_uninstall"
        ],
        "categories": [
            {
                "id": "example-catalog",
                "title": "Python reference artifacts",
                "description": "Sample entries that document downloads bridge request/response fields. resolve_install returns step templates (download_file, extract_zip, python_package) without downloading in this reference module.",
                "groupKey": "python-reference",
                "targetRef": "example_data",
                "sortOrder": 10
            }
        ],
        "targets": {
            "example_data": {
                "root": "Data",
                "relative": "example-downloads",
                "description": "Install root: <module>/Data/example-downloads/ — used as targetRef in installManifest/uninstallManifest from this bridge."
            }
        }
    },
    "moduleInterop": {
        "protocolVersion": 1,
        "client": {
            "enabled": true
        }
    },
    "status": {
        "installed": false,
        "enabled": false,
        "firstRunCompleted": false
    }
}