ProdDash/modules/prodcom-transcript/module.json

{
  "id": "prodcom-transcript",
  "name": "ProdCom",
  "version": "1.5.0",
  "proddash": ">=1.4.0",
  "description": "Live ProdCom transcript; typed text to a ProdCom channel through the Send Message module",
  "permissions": [
    {
      "kind": "local-network",
      "reason": "Reaching the ProdCom API on this network"
    }
  ],
  "provides": [
    "messaging"
  ],
  "client": "client.js",
  "server": "server.js",
  "style": "style.css",
  "minSize": {
    "w": 3,
    "h": 2
  },
  "defaultSize": {
    "w": 4,
    "h": 4
  },
  "configSchema": {
    "prodcom": {
      "type": "endpoint",
      "label": "ProdCom server",
      "default": {
        "host": "",
        "port": 24480
      },
      "help": "The ProdCom server at THIS location — every campus has its own. Blank until you set it, so a new install never reads another campus’s comms. The Send Message module sends typed text to these channels through this connection."
    },
    "apiKey": {
      "type": "password",
      "label": "API key (only if PSK auth is enabled in ProdCom)",
      "default": ""
    },
    "autoStart": {
      "type": "switch",
      "label": "Start ProdCom when it is offline",
      "default": true,
      "help": "Only when ProdCom runs on this machine (the server above is 127.0.0.1 or this Mac’s own address). If ProdCom is not running, ProdDash opens it — up to three tries, five seconds apart. macOS only."
    },
    "apiRestart": {
      "type": "switch",
      "label": "Restart ProdCom to turn its API on",
      "default": true,
      "showWhen": "autoStart",
      "help": "When ProdCom is running but its Application API is switched off, ProdDash turns the API on and restarts ProdCom to apply it (about ten seconds without intercom). Off: the API is turned on for ProdCom’s next start and the tile says to restart it."
    }
  },
  "instanceSchema": {
    "showAvatars": {
      "type": "boolean",
      "label": "Channel icons",
      "default": true
    }
  }
}