initiative-plugin-sdk 5.0.0 → 6.0.0

package/schemas/plugin-manifest.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://initiativetasks.com/schemas/plugin-manifest-v1.json",
   "title": "Initiative plug-in manifest (the 'definition' body)",
-  "description": "What a plug-in declares it can do. A plug-in is a container, which names its `service` and answers Initiative's calls, or declarative, which names its `hosts` and no service, and whose endpoints, connection checks and webhook events Initiative runs itself from the requests and JSONata expressions written here; one plug-in is never both. This is the 'definition' field of the document served at /.well-known/initiative-plugin.json, NOT that whole document: a registrar also requires protocol_version, public_id and kind alongside it, and refuses a definition served bare. Generated from the platform's own validator vocabulary. A manifest that satisfies this schema is well-formed, not necessarily acceptable. Cross-references (the endpoint a widget binds, a requires term's connection, an endpoint's service prefix), the direction-specific rules on an endpoint, the features/blocks cross-check in both directions, UTF-8 byte-size caps, the rules tying a connection's flow and token to its scope and fields, what a webhooks block names, what a vendor setup writes to, whether every expression parses, what a declarative request and its steps name, and the bounds and unique ids of schedules are enforced by the platform on publish and are not expressible here.",
+  "description": "What a plug-in declares it can do. A plug-in is a container, which names its `service` and answers Initiative's calls, or declarative, which names its `hosts` and no service, and whose endpoints, connection checks and webhook events Initiative runs itself from the requests and JSONata expressions written here; one plug-in is never both. This is the 'definition' field of the document served at /.well-known/initiative-plugin.json, NOT that whole document: a registrar also requires protocol_version, public_id and kind alongside it, and refuses a definition served bare. Generated from the platform's own validator vocabulary. A manifest that satisfies this schema is well-formed, not necessarily acceptable. Cross-references (the endpoint a widget binds, a requires term's connection, an endpoint's service prefix), the direction-specific rules on an endpoint, the features/blocks cross-check in both directions, UTF-8 byte-size caps, the rules tying a connection's flow and token to its scope and fields, what a webhooks block names, what a vendor setup writes to, whether every expression parses, what a declarative request and its steps name, the bounds and unique ids of schedules, the unique keys and ids of fields, parts and actions, what a part's nodes and an action name, and a part's size and depth are enforced by the platform on publish and are not expressible here.",
   "type": "object",
   "required": [
     "plugin_kind",
@@ -85,12 +85,15 @@
     },
     "features": {
       "type": "array",
-      "maxItems": 4,
+      "maxItems": 7,
       "items": {
         "enum": [
+          "actions",
           "dashboards",
           "endpoints",
+          "fields",
           "pages",
+          "parts",
           "widgets"
         ]
       },
@@ -187,6 +190,30 @@
         "$ref": "#/$defs/bundledDashboard"
       },
       "description": "Ready-made arrangements of this plug-in's own widgets. Publishing the plug-in publishes one ordinary dashboard listing per entry, offered to communities that install the plug-in."
+    },
+    "fields": {
+      "type": "array",
+      "maxItems": 32,
+      "items": {
+        "$ref": "#/$defs/field"
+      },
+      "description": "How the plug-in's metadata is shown on items. A container plug-in's only: a declarative plug-in holds no installation token, so it keeps no metadata to show."
+    },
+    "parts": {
+      "type": "array",
+      "maxItems": 16,
+      "items": {
+        "$ref": "#/$defs/part"
+      },
+      "description": "Pieces of items' pages and views, built from Initiative's components and bound to the plug-in's fields and actions. A container plug-in's only, as fields are."
+    },
+    "actions": {
+      "type": "array",
+      "maxItems": 16,
+      "items": {
+        "$ref": "#/$defs/action"
+      },
+      "description": "What a reader may run on an item, each one of the plug-in's write endpoints. A container plug-in's only: a declarative plug-in has no handler to do an action's work."
     }
   },
   "$defs": {
@@ -1152,6 +1179,412 @@
         }
       }
     },
+    "metadataKey": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 64,
+      "pattern": "^[a-z][.0123456789_abcdefghijklmnopqrstuvwxyz]*$",
+      "description": "A key the plug-in keeps a value under, on an item or on its own install: a lowercase letter, then lowercase letters, digits, '_' and '.'."
+    },
+    "field": {
+      "type": "object",
+      "description": "How one of the plug-in's metadata keys is shown on Initiative's items. The plug-in keeps the value in Initiative, through its installation token; Initiative draws it with its own component for `kind` and computes its plain text itself, so a field filters, sorts and exports with no call to the plug-in. Which views show it is chosen by the community's managers, never by the plug-in. Initiative holds what is kept, and these caps are enforced there rather than here: a value of at most 8192 bytes as JSON, with a string of at most 255 characters to be found by; at most 32 keys and 65536 bytes on one item, and 256 keys and 1048576 bytes on the install.",
+      "required": [
+        "key",
+        "name",
+        "kind",
+        "on"
+      ],
+      "properties": {
+        "key": {
+          "$ref": "#/$defs/metadataKey",
+          "description": "The metadata key whose value this shows. Unique among this manifest's fields."
+        },
+        "name": {
+          "$ref": "#/$defs/localizedText",
+          "description": "The field's label."
+        },
+        "kind": {
+          "enum": [
+            "text",
+            "number",
+            "date",
+            "datetime",
+            "link",
+            "badge",
+            "progress",
+            "checkbox"
+          ],
+          "description": "What the value is, and so how it is drawn: 'text' a string; 'number' a number; 'date' a 'YYYY-MM-DD' string; 'datetime' an ISO 8601 string with its offset; 'link' {url, text?}; 'badge' {text, tone?}; 'progress' {value, max}; 'checkbox' a boolean."
+        },
+        "on": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 6,
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "task",
+              "calendar_event",
+              "queue_item",
+              "counter",
+              "gallery_image",
+              "post"
+            ]
+          },
+          "description": "The item kinds it is offered on."
+        },
+        "description": {
+          "$ref": "#/$defs/localizedText",
+          "description": "The one line the view editor's Add picker shows beside the name."
+        },
+        "tone": {
+          "enum": [
+            "accent",
+            "positive",
+            "negative",
+            "warning",
+            "neutral",
+            "muted"
+          ],
+          "description": "A badge's tone when its value names none."
+        },
+        "requires": {
+          "$ref": "#/$defs/requires"
+        }
+      }
+    },
+    "partNode": {
+      "description": "One node of a part: one of Initiative's own components, told apart by 'type', with its props and, for a section or a stack, the nodes inside it.",
+      "oneOf": [
+        {
+          "$ref": "#/$defs/sectionNode"
+        },
+        {
+          "$ref": "#/$defs/stackNode"
+        },
+        {
+          "$ref": "#/$defs/fieldNode"
+        },
+        {
+          "$ref": "#/$defs/valueNode"
+        },
+        {
+          "$ref": "#/$defs/textNode"
+        },
+        {
+          "$ref": "#/$defs/buttonNode"
+        }
+      ]
+    },
+    "sectionNode": {
+      "type": "object",
+      "description": "A titled group, which the reader may fold.",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "section"
+        },
+        "props": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "$ref": "#/$defs/localizedText"
+            },
+            "collapsed": {
+              "type": "boolean",
+              "default": false,
+              "description": "Drawn folded until the reader opens it."
+            }
+          },
+          "additionalProperties": false
+        },
+        "children": {
+          "type": "array",
+          "maxItems": 50,
+          "items": {
+            "$ref": "#/$defs/partNode"
+          },
+          "description": "Drawn in order, inside this one."
+        }
+      },
+      "additionalProperties": false
+    },
+    "stackNode": {
+      "type": "object",
+      "description": "Nodes side by side or one above another.",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "stack"
+        },
+        "props": {
+          "type": "object",
+          "properties": {
+            "direction": {
+              "enum": [
+                "row",
+                "column"
+              ],
+              "default": "column"
+            },
+            "gap": {
+              "enum": [
+                "none",
+                "small",
+                "medium",
+                "large"
+              ],
+              "description": "The space between the nodes. Absent: Initiative's own."
+            },
+            "wrap": {
+              "type": "boolean",
+              "default": false,
+              "description": "A row runs onto a second line rather than past its edge."
+            }
+          },
+          "additionalProperties": false
+        },
+        "children": {
+          "type": "array",
+          "maxItems": 50,
+          "items": {
+            "$ref": "#/$defs/partNode"
+          },
+          "description": "Drawn in order, inside this one."
+        }
+      },
+      "additionalProperties": false
+    },
+    "fieldNode": {
+      "type": "object",
+      "description": "A field's label and its value.",
+      "required": [
+        "type",
+        "props"
+      ],
+      "properties": {
+        "type": {
+          "const": "field"
+        },
+        "props": {
+          "type": "object",
+          "required": [
+            "field"
+          ],
+          "properties": {
+            "field": {
+              "$ref": "#/$defs/metadataKey",
+              "description": "One of this manifest's fields, by its key, offered on every item kind the part is."
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "valueNode": {
+      "type": "object",
+      "description": "A field's value alone.",
+      "required": [
+        "type",
+        "props"
+      ],
+      "properties": {
+        "type": {
+          "const": "value"
+        },
+        "props": {
+          "type": "object",
+          "required": [
+            "field"
+          ],
+          "properties": {
+            "field": {
+              "$ref": "#/$defs/metadataKey",
+              "description": "One of this manifest's fields, by its key, offered on every item kind the part is."
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "textNode": {
+      "type": "object",
+      "description": "Words the plug-in wrote.",
+      "required": [
+        "type",
+        "props"
+      ],
+      "properties": {
+        "type": {
+          "const": "text"
+        },
+        "props": {
+          "type": "object",
+          "required": [
+            "text"
+          ],
+          "properties": {
+            "text": {
+              "$ref": "#/$defs/localizedText"
+            },
+            "tone": {
+              "enum": [
+                "accent",
+                "positive",
+                "negative",
+                "warning",
+                "neutral",
+                "muted"
+              ]
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "buttonNode": {
+      "type": "object",
+      "description": "A button that runs one of this plug-in's actions on the item, labelled with the action's name.",
+      "required": [
+        "type",
+        "props"
+      ],
+      "properties": {
+        "type": {
+          "const": "button"
+        },
+        "props": {
+          "type": "object",
+          "required": [
+            "action"
+          ],
+          "properties": {
+            "action": {
+              "$ref": "#/$defs/identifier",
+              "description": "One of this manifest's actions, by its id, offered on every item kind the part is."
+            },
+            "variant": {
+              "enum": [
+                "primary",
+                "secondary",
+                "ghost"
+              ]
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    "part": {
+      "type": "object",
+      "description": "A piece of an item's page or view, built from Initiative's own components and bound to this plug-in's fields and actions. Data only: Initiative draws each node, and no plug-in code runs in the reader's browser. Which views show it is chosen by the community's managers, never by the plug-in, and Initiative places at most 3 of a plug-in's parts on one item.",
+      "required": [
+        "id",
+        "name",
+        "on",
+        "tree"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/identifier",
+          "description": "Unique among this manifest's parts."
+        },
+        "name": {
+          "$ref": "#/$defs/localizedText",
+          "description": "What the view editor calls it."
+        },
+        "on": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 6,
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "task",
+              "calendar_event",
+              "queue_item",
+              "counter",
+              "gallery_image",
+              "post"
+            ]
+          },
+          "description": "The item kinds it is offered on."
+        },
+        "tree": {
+          "$ref": "#/$defs/partNode",
+          "description": "What is drawn: at most 50 nodes, at most 4 deep."
+        },
+        "description": {
+          "$ref": "#/$defs/localizedText",
+          "description": "The one line the view editor's Add picker shows beside the name."
+        },
+        "requires": {
+          "$ref": "#/$defs/requires"
+        }
+      }
+    },
+    "action": {
+      "type": "object",
+      "description": "Something a reader runs on one item, from a part's button or the item's own menu. Initiative only connects: it calls the write endpoint as the installation, with the reader as 'viewer' and the item as 'subject' in the call's token, and the endpoint does the work, usually writing the plug-in's metadata. Initiative then answers the reader with the item's metadata as it stands.",
+      "required": [
+        "id",
+        "name",
+        "endpoint",
+        "on"
+      ],
+      "properties": {
+        "id": {
+          "$ref": "#/$defs/identifier",
+          "description": "Unique among this manifest's actions."
+        },
+        "name": {
+          "$ref": "#/$defs/localizedText",
+          "description": "The button's or the menu entry's label."
+        },
+        "endpoint": {
+          "$ref": "#/$defs/namespacedId",
+          "description": "A write endpoint this manifest declares."
+        },
+        "on": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 6,
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "task",
+              "calendar_event",
+              "queue_item",
+              "counter",
+              "gallery_image",
+              "post"
+            ]
+          },
+          "description": "The item kinds it is offered on."
+        },
+        "confirm": {
+          "$ref": "#/$defs/localizedText",
+          "description": "A question Initiative asks before running it. Absent: it runs at once."
+        },
+        "menu": {
+          "type": "boolean",
+          "default": false,
+          "description": "Also offered in the item's own menu."
+        },
+        "requires": {
+          "$ref": "#/$defs/requires"
+        }
+      }
+    },
     "bundledDashboard": {
       "type": "object",
       "required": [