initiative-plugin-sdk 4.1.0 → 4.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +64 -10
- package/dist/contract.d.ts +11 -1
- package/dist/contract.js +1 -1
- package/dist/contract.js.map +1 -1
- package/dist/define.d.ts +8 -0
- package/dist/define.js +1 -0
- package/dist/define.js.map +1 -1
- package/dist/manifest.d.ts +3 -1
- package/dist/manifest.js +3 -1
- package/dist/manifest.js.map +1 -1
- package/dist/plugin-api.d.ts +20 -0
- package/dist/plugin-api.generated.d.ts +2 -2
- package/dist/plugin-api.generated.js +2 -2
- package/dist/plugin-api.js +35 -0
- package/dist/plugin-api.js.map +1 -0
- package/manifest.contract.json +6 -1
- package/package.json +6 -5
- package/schemas/env-contract.json +1 -1
- package/schemas/plugin-api.json +20925 -0
- package/schemas/plugin-manifest.json +6 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://
|
|
3
|
+
"$id": "https://initiativetasks.com/schemas/plugin-manifest-v1.json",
|
|
4
4
|
"title": "Initiative plug-in manifest (the 'definition' body)",
|
|
5
5
|
"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.",
|
|
6
6
|
"type": "object",
|
|
@@ -115,6 +115,11 @@
|
|
|
115
115
|
},
|
|
116
116
|
"description": "How old somebody must be to use this plug-in, by where they are. Keys are ISO 3166-1 alpha-2 country codes, upper case, and 'default' for every country not listed: {\"default\": 16, \"US\": 13}. The age of digital consent differs by country, inside the EU as well as outside it, which is why a region is a country rather than a regime. Absent, or a country with no entry and no 'default': the deployment's own minimum applies. A declaration, not a gate: whether a deployment enforces it, and how it learns somebody's age and country, are its decisions. At most 64 entries, each from 13 to 21."
|
|
117
117
|
},
|
|
118
|
+
"min_plugin_api": {
|
|
119
|
+
"type": "string",
|
|
120
|
+
"pattern": "^[0-9]+\\.[0-9]+$",
|
|
121
|
+
"description": "The oldest plug-in API contract this plug-in needs, as 'MAJOR.MINOR': '4.1'. The contract is the plug-in API published with initiative-plugin-sdk, versioned as that package is. A deployment serving contract S can run it when S has the same major version and a minor version at least this one's. Absent: any contract; the plug-in makes no claim. Beside a listing's min_app_version, the oldest Initiative release it runs on, this says what the plug-in calls rather than which release serves it."
|
|
122
|
+
},
|
|
118
123
|
"hosts": {
|
|
119
124
|
"type": "array",
|
|
120
125
|
"minItems": 1,
|