scriptwidget/Shared/ScriptWidgetRuntime/Resource/widget.schema.json at main · everettjf/scriptwidget · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://scriptwidget.app/schemas/widget-2.json",
  "title": "ScriptWidget Package 2.0 manifest",
  "type": "object",
  "additionalProperties": false,
  "required": ["formatVersion", "id", "name", "version", "runtimeVersion", "entry", "supportedFamilies", "permissions", "networkDomains"],
  "properties": {
    "formatVersion": { "const": 2 },
    "id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{2,127}$" },
    "name": { "type": "string", "minLength": 1, "maxLength": 80 },
    "version": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+(?:-[0-9A-Za-z.-]+)?$" },
    "runtimeVersion": { "const": "1.0" },
    "entry": { "type": "string", "pattern": "^[^/\\\\].*\\.(?:js|jsx)$" },
    "supportedFamilies": {
      "type": "array", "minItems": 1, "uniqueItems": true,
      "items": { "enum": ["systemSmall", "systemMedium", "systemLarge", "systemExtraLarge", "systemExtraLargePortrait", "accessoryCircular", "accessoryRectangular", "accessoryInline"] }
    },
    "permissions": {
      "type": "array", "uniqueItems": true,
      "items": { "enum": ["network", "location", "health", "storage", "files"] }
    },
    "networkDomains": {
      "type": "array", "uniqueItems": true,
      "items": { "type": "string", "pattern": "^(?:\\*\\.)?[a-z0-9](?:[a-z0-9.-]*[a-z0-9])?$" }
    },
    "plugins": {
      "type": "array", "uniqueItems": true,
      "items": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{2,127}$" }
    },
    "actions": {
      "type": "array", "maxItems": 16,
      "items": {
        "type": "object", "additionalProperties": false,
        "required": ["id", "title", "systemImage", "function"],
        "properties": {
          "id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{0,63}$" },
          "title": { "type": "string", "minLength": 1, "maxLength": 40 },
          "description": { "type": "string", "maxLength": 160 },
          "systemImage": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{0,79}$" },
          "function": { "type": "string", "pattern": "^[A-Za-z_$][A-Za-z0-9_$]{0,63}$" }
        }
      }
    },
    "controls": {
      "type": "array", "maxItems": 8,
      "items": {
        "type": "object", "additionalProperties": false,
        "required": ["id", "type", "title", "systemImage"],
        "properties": {
          "id": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{0,63}$" },
          "type": { "enum": ["button", "toggle"] },
          "title": { "type": "string", "minLength": 1, "maxLength": 40 },
          "subtitle": { "type": "string", "maxLength": 80 },
          "systemImage": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{0,79}$" },
          "action": { "type": "string", "pattern": "^[A-Za-z_$][A-Za-z0-9_$]{0,63}$" },
          "actionID": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9.-]{0,63}$" },
          "stateKey": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" }
        },
        "allOf": [
          { "oneOf": [{ "required": ["action"] }, { "required": ["actionID"] }] },
          { "if": { "properties": { "type": { "const": "toggle" } } }, "then": { "required": ["stateKey"] } },
          { "if": { "properties": { "type": { "const": "button" } } }, "then": { "not": { "required": ["stateKey"] } } }
        ]
      }
    },
    "pushUpdates": {
      "type": "object", "additionalProperties": false,
      "required": ["registrationURL", "channel"],
      "properties": {
        "registrationURL": { "type": "string", "format": "uri", "pattern": "^https://" },
        "channel": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$" }
      }
    },
    "description": { "type": "string" },
    "category": { "type": "string" },
    "tags": { "type": "array", "maxItems": 20, "items": { "type": "string" } },
    "icon": { "type": "string" },
    "preview": { "type": "string" },
    "author": {
      "type": "object", "additionalProperties": false, "required": ["name"],
      "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri", "pattern": "^https://" } }
    },
    "license": { "type": "string" }
  }
}