workflow-plugin-websocket/plugin.json at main · GoCodeAlone/workflow-plugin-websocket · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
{
    "name": "workflow-plugin-websocket",
    "version": "0.0.0",
    "author": "GoCodeAlone",
    "description": "General-purpose WebSocket support for workflow applications",
    "type": "external",
    "tier": "community",
    "license": "MIT",
    "repository": "https://github.com/GoCodeAlone/workflow-plugin-websocket",
    "homepage": "https://github.com/GoCodeAlone/workflow-plugin-websocket",
    "minEngineVersion": "0.51.7",
    "keywords": [
        "websocket",
        "ws",
        "realtime",
        "streaming"
    ],
    "capabilities": {
        "moduleTypes": [
            "ws.server"
        ],
        "stepTypes": [
            "step.ws_send",
            "step.ws_close"
        ],
        "triggerTypes": [
            "websocket"
        ]
    },
    "stepSchemas": [
        {
            "type": "step.ws_send",
            "plugin": "workflow-plugin-websocket",
            "description": "Send a text message to a WebSocket connection by connection ID.",
            "configFields": [
                {
                    "key": "connectionId",
                    "label": "Connection ID",
                    "type": "string",
                    "description": "The unique identifier of the WebSocket connection to send the message to.",
                    "required": true,
                    "placeholder": "{{ .connectionId }}"
                },
                {
                    "key": "message",
                    "label": "Message",
                    "type": "string",
                    "description": "The text message to send to the WebSocket connection.",
                    "required": true,
                    "placeholder": "Hello, world!"
                }
            ],
            "outputs": [
                {
                    "key": "sent",
                    "type": "boolean",
                    "description": "Whether the message was successfully sent to the connection."
                },
                {
                    "key": "error",
                    "type": "string",
                    "description": "Error message when the send failed (e.g. ws.server not initialized, missing connectionId).",
                    "optional": true
                }
            ]
        },
        {
            "type": "step.ws_close",
            "plugin": "workflow-plugin-websocket",
            "description": "Close a WebSocket connection by connection ID.",
            "configFields": [
                {
                    "key": "connectionId",
                    "label": "Connection ID",
                    "type": "string",
                    "description": "The unique identifier of the WebSocket connection to close.",
                    "required": true,
                    "placeholder": "{{ .connectionId }}"
                }
            ],
            "outputs": [
                {
                    "key": "closed",
                    "type": "boolean",
                    "description": "Whether the connection was found and closed."
                },
                {
                    "key": "error",
                    "type": "string",
                    "description": "Error message when the close failed (e.g. ws.server not initialized).",
                    "optional": true
                }
            ]
        }
    ]
}