initiative-plugin-sdk 7.1.0 → 8.0.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/README.md +385 -51
- package/dist/build.d.ts +1 -1
- package/dist/build.js +32 -22
- package/dist/build.js.map +1 -1
- package/dist/client.d.ts +17 -6
- package/dist/client.js +12 -8
- package/dist/client.js.map +1 -1
- package/dist/contract.d.ts +452 -80
- package/dist/contract.js +22 -6
- package/dist/contract.js.map +1 -1
- package/dist/define.d.ts +78 -31
- package/dist/define.js +27 -9
- package/dist/define.js.map +1 -1
- package/dist/manifest.d.ts +1 -1
- package/dist/manifest.js.map +1 -1
- package/dist/plugin-api.generated.d.ts +97 -5
- package/dist/plugin-api.generated.js +15 -2
- package/dist/plugin-api.generated.js.map +1 -1
- package/dist/server.d.ts +1 -0
- package/dist/server.js +21 -5
- package/dist/server.js.map +1 -1
- package/dist/statements.d.ts +111 -0
- package/dist/statements.js +205 -0
- package/dist/statements.js.map +1 -0
- package/dist/testing.d.ts +132 -21
- package/dist/testing.js +273 -51
- package/dist/testing.js.map +1 -1
- package/dist/validate.d.ts +13 -4
- package/dist/validate.js +240 -48
- package/dist/validate.js.map +1 -1
- package/manifest.contract.json +514 -23
- package/package.json +1 -1
- package/schemas/plugin-api.json +462 -33
- package/schemas/plugin-manifest.json +553 -22
package/dist/contract.js
CHANGED
|
@@ -31,6 +31,8 @@ export const PAGE_CAPABILITIES = ["camera", "clipboard-read", "clipboard-write",
|
|
|
31
31
|
export const ITEM_KINDS = ["task", "calendar_event", "queue_item", "counter", "gallery_image", "post"];
|
|
32
32
|
export const FIELD_KINDS = ["text", "number", "date", "datetime", "link", "badge", "progress", "checkbox"];
|
|
33
33
|
export const TONES = ["accent", "positive", "negative", "warning", "neutral", "muted"];
|
|
34
|
+
export const SETTING_TYPES = ["string"];
|
|
35
|
+
export const SETTING_ASSIGNMENTS = ["community_name"];
|
|
34
36
|
export const LISTING_KINDS = ["plugin", "dashboard"];
|
|
35
37
|
export const HTTP_METHODS = ["DELETE", "GET", "PATCH", "POST", "PUT"];
|
|
36
38
|
export const PAGE_LIMITS = ["refuse", "truncate"];
|
|
@@ -62,6 +64,8 @@ export const CAPS = {
|
|
|
62
64
|
actions: 16,
|
|
63
65
|
partNodes: 50,
|
|
64
66
|
partDepth: 4,
|
|
67
|
+
facetsPerField: 4,
|
|
68
|
+
valuesPerFacet: 12,
|
|
65
69
|
metadataKeyLength: 64,
|
|
66
70
|
metadataValueBytes: 8192,
|
|
67
71
|
metadataLookupLength: 255,
|
|
@@ -69,7 +73,11 @@ export const CAPS = {
|
|
|
69
73
|
metadataBytesPerObject: 65536,
|
|
70
74
|
installMetadataKeys: 256,
|
|
71
75
|
installMetadataBytes: 1048576,
|
|
76
|
+
writeTargets: 100,
|
|
72
77
|
partsPlacedPerItem: 3,
|
|
78
|
+
settings: 16,
|
|
79
|
+
uniqueSettingValueLength: 16,
|
|
80
|
+
helpLength: 2000,
|
|
73
81
|
bundledDashboards: 8,
|
|
74
82
|
dashboardWidgets: 50,
|
|
75
83
|
dashboardGridColumns: 12,
|
|
@@ -138,6 +146,7 @@ export const CHARSETS = {
|
|
|
138
146
|
artwork: "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/._-",
|
|
139
147
|
queryName: "-.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ[]_abcdefghijklmnopqrstuvwxyz~",
|
|
140
148
|
metadataKey: "._0123456789abcdefghijklmnopqrstuvwxyz",
|
|
149
|
+
uniqueSettingValue: "0123456789abcdefghijklmnopqrstuvwxyz",
|
|
141
150
|
};
|
|
142
151
|
/**
|
|
143
152
|
* Every field the contract declares, by the object that owns it.
|
|
@@ -157,15 +166,17 @@ export const FIELDS = {
|
|
|
157
166
|
endpointReturn: ["key", "type", "label", "list", "of"],
|
|
158
167
|
connection: ["id", "scope", "label", "fields", "flow", "token", "access_hint", "health"],
|
|
159
168
|
connectionFlow: ["type", "authorize_url", "token_url", "client_id", "client_secret", "scopes", "pkce", "authorize_params", "install_url", "after_connect", "revoke", "revoke_url"],
|
|
160
|
-
connectionToken: ["type", "exchange_url", "iss", "key", "alg", "lifetime"],
|
|
169
|
+
connectionToken: ["type", "exchange_url", "exchange_body", "iss", "key", "alg", "lifetime"],
|
|
161
170
|
webhooks: ["verify", "dedup", "route", "events", "status"],
|
|
162
171
|
webhookVerify: ["scheme", "header", "prefix", "encoding", "secret"],
|
|
163
172
|
webhookRoute: ["path", "header", "connection", "field"],
|
|
164
|
-
schedule: ["id", "every"],
|
|
173
|
+
schedule: ["id", "every", "endpoint", "params", "write"],
|
|
165
174
|
endpoint: ["id", "label", "description", "returns", "group", "needs_subject", "direction", "params", "actors", "admin_only", "public", "requires", "cache_ttl_seconds", "identity", "unavailable", "request", "steps", "map", "errors"],
|
|
166
175
|
widget: ["id", "meta", "module_source", "endpoints", "sample_data", "requires"],
|
|
167
176
|
page: ["id", "path", "name", "scopes", "admin_only", "capabilities", "requires"],
|
|
168
|
-
field: ["key", "name", "kind", "on", "description", "tone", "requires"],
|
|
177
|
+
field: ["key", "name", "kind", "list", "on", "description", "tone", "states", "actions", "requires"],
|
|
178
|
+
stateFacet: ["name", "values"],
|
|
179
|
+
stateValue: ["label", "tone"],
|
|
169
180
|
sectionNode: ["type", "props", "children"],
|
|
170
181
|
stackNode: ["type", "props", "children"],
|
|
171
182
|
fieldNode: ["type", "props"],
|
|
@@ -173,13 +184,18 @@ export const FIELDS = {
|
|
|
173
184
|
textNode: ["type", "props"],
|
|
174
185
|
buttonNode: ["type", "props"],
|
|
175
186
|
part: ["id", "name", "on", "tree", "description", "requires"],
|
|
176
|
-
action: ["id", "name", "endpoint", "on", "confirm", "menu", "requires"],
|
|
187
|
+
action: ["id", "name", "endpoint", "params", "write", "on", "confirm", "menu", "admin_only", "requires"],
|
|
188
|
+
change: ["set", "upsert", "remove"],
|
|
189
|
+
targetedChange: ["target", "set", "upsert", "remove"],
|
|
190
|
+
listElement: ["ref", "value", "url", "text", "tone", "max", "state"],
|
|
191
|
+
setting: ["key", "type", "label", "description", "unique", "assigned"],
|
|
177
192
|
bundledDashboard: ["uid", "public_id", "name", "description", "layout", "widgets"],
|
|
178
193
|
bundledDashboardWidget: ["id", "type", "title", "grid", "binding"],
|
|
179
194
|
endpointIdentity: ["kind", "key"],
|
|
180
195
|
vendorAuth: ["header", "prefix"],
|
|
181
196
|
vendorRequest: ["method", "url", "query", "headers", "body", "graphql", "connection", "paging"],
|
|
182
197
|
graphqlRequest: ["query", "variables"],
|
|
198
|
+
actorConnections: ["member", "installation"],
|
|
183
199
|
requestStep: ["name", "request"],
|
|
184
200
|
pageNumberPaging: ["kind", "page_param", "per_page_param", "per_page", "items", "max_pages", "on_limit"],
|
|
185
201
|
linkHeaderPaging: ["kind", "items", "max_pages", "on_limit"],
|
|
@@ -188,8 +204,8 @@ export const FIELDS = {
|
|
|
188
204
|
afterConnect: ["request", "steps", "map", "refuse_when", "code"],
|
|
189
205
|
connectionHealth: ["request", "every", "states"],
|
|
190
206
|
healthState: ["status", "when", "state"],
|
|
191
|
-
webhookEvent: ["when", "emit", "map"],
|
|
207
|
+
webhookEvent: ["when", "emit", "map", "write"],
|
|
192
208
|
webhookStatus: ["when", "connection", "state"],
|
|
193
|
-
manifest: ["plugin_kind", "service", "features", "default_name", "minimum_age", "min_plugin_api", "hosts", "auth", "vendor", "connections", "webhooks", "schedules", "endpoints", "community_summary", "widgets", "pages", "dashboards", "fields", "parts", "actions"],
|
|
209
|
+
manifest: ["plugin_kind", "service", "features", "default_name", "minimum_age", "min_plugin_api", "hosts", "auth", "scopes", "vendor", "connections", "webhooks", "schedules", "endpoints", "community_summary", "widgets", "pages", "dashboards", "fields", "parts", "actions", "settings", "help"],
|
|
194
210
|
};
|
|
195
211
|
//# sourceMappingURL=contract.js.map
|
package/dist/contract.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,MAAM,CAAC,MAAM,QAAQ,GAAuB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AAG1H,MAAM,CAAC,MAAM,SAAS,GAAwB,CAAC,CAAC,CAAC,CAAC;AAGlD,MAAM,CAAC,MAAM,iBAAiB,GAA+B,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAGvF,MAAM,CAAC,MAAM,UAAU,GAAwB,CAAC,QAAQ,CAAC,CAAC;AAG1D,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,YAAY,CAAC,CAAC;AAGhE,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,cAAc,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAG3F,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAG1E,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAGtG,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAG1F,MAAM,CAAC,MAAM,wBAAwB,GAAqC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAG5F,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAGlI,MAAM,CAAC,MAAM,eAAe,GAA6B,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;AAGtF,MAAM,CAAC,MAAM,iBAAiB,GAA+B,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAG/E,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAGxG,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAG3G,MAAM,CAAC,MAAM,UAAU,GAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAG1E,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AAG5E,MAAM,CAAC,MAAM,MAAM,GAAqB,CAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,iBAAiB,CAAC,CAAC;AAGpmB,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AAGnF,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;AAG1K,MAAM,CAAC,MAAM,UAAU,GAAwB,CAAC,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;AAG5H,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAGjI,MAAM,CAAC,MAAM,KAAK,GAAoB,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAGxG,MAAM,CAAC,MAAM,aAAa,GAA2B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAG7E,MAAM,CAAC,MAAM,YAAY,GAA0B,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAG7F,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;AAGxE,MAAM,CAAC,MAAM,aAAa,GAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAGlF,MAAM,CAAC,MAAM,iBAAiB,GAA+B,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;AAG3G,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;AAEvI,0EAA0E;AAC1E,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,WAAW,EAAE,EAAE;IACf,mBAAmB,EAAE,EAAE;IACvB,YAAY,EAAE,EAAE;IAChB,oBAAoB,EAAE,GAAG;IACzB,eAAe,EAAE,GAAG;IACpB,UAAU,EAAE,EAAE;IACd,eAAe,EAAE,EAAE;IACnB,oBAAoB,EAAE,GAAG;IACzB,aAAa,EAAE,EAAE;IACjB,gBAAgB,EAAE,EAAE;IACpB,aAAa,EAAE,EAAE;IACjB,OAAO,EAAE,EAAE;IACX,eAAe,EAAE,CAAC;IAClB,SAAS,EAAE,EAAE;IACb,iBAAiB,EAAE,EAAE;IACrB,kBAAkB,EAAE,EAAE;IACtB,KAAK,EAAE,EAAE;IACT,gBAAgB,EAAE,CAAC;IACnB,MAAM,EAAE,EAAE;IACV,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,CAAC;IACZ,iBAAiB,EAAE,EAAE;IACrB,kBAAkB,EAAE,IAAI;IACxB,oBAAoB,EAAE,GAAG;IACzB,qBAAqB,EAAE,EAAE;IACzB,sBAAsB,EAAE,KAAK;IAC7B,mBAAmB,EAAE,GAAG;IACxB,oBAAoB,EAAE,OAAO;IAC7B,kBAAkB,EAAE,CAAC;IACrB,iBAAiB,EAAE,CAAC;IACpB,gBAAgB,EAAE,EAAE;IACpB,oBAAoB,EAAE,EAAE;IACxB,sBAAsB,EAAE,EAAE;IAC1B,gBAAgB,EAAE,EAAE;IACpB,cAAc,EAAE,GAAG;IACnB,UAAU,EAAE,GAAG;IACf,gBAAgB,EAAE,GAAG;IACrB,UAAU,EAAE,GAAG;IACf,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,GAAG;IACf,iBAAiB,EAAE,GAAG;IACtB,gBAAgB,EAAE,IAAI;IACtB,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,GAAG;IACf,OAAO,EAAE,EAAE;IACX,eAAe,EAAE,KAAK;IACtB,iBAAiB,EAAE,KAAK;IACxB,eAAe,EAAE,KAAK;IACtB,sBAAsB,EAAE,MAAM;IAC9B,aAAa,EAAE,EAAE;IACjB,mBAAmB,EAAE,GAAG;IACxB,SAAS,EAAE,GAAG;IACd,eAAe,EAAE,EAAE;IACnB,uBAAuB,EAAE,GAAG;IAC5B,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,EAAE;IACnB,gBAAgB,EAAE,CAAC;IACnB,YAAY,EAAE,EAAE;IAChB,SAAS,EAAE,CAAC;IACZ,kBAAkB,EAAE,CAAC;IACrB,kBAAkB,EAAE,IAAI;IACxB,mBAAmB,EAAE,CAAC;IACtB,KAAK,EAAE,CAAC;IACR,UAAU,EAAE,GAAG;IACf,KAAK,EAAE,CAAC;IACR,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,GAAG;IACZ,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,EAAE;IAClB,UAAU,EAAE,EAAE;IACd,gBAAgB,EAAE,EAAE;IACpB,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,EAAE;IACnB,YAAY,EAAE,EAAE;IAChB,UAAU,EAAE,GAAG;IACf,gBAAgB,EAAE,KAAK;IACvB,aAAa,EAAE,KAAK;IACpB,gBAAgB,EAAE,IAAI;IACtB,eAAe,EAAE,GAAG;IACpB,qBAAqB,EAAE,OAAO;IAC9B,iBAAiB,EAAE,EAAE;IACrB,eAAe,EAAE,EAAE;CACX,CAAC;AAEX,uDAAuD;AACvD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,UAAU,EAAE,wCAAwC;IACpD,YAAY,EAAE,yCAAyC;IACvD,QAAQ,EAAE,yCAAyC;IACnD,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,oEAAoE;IAC1E,UAAU,EAAE,iEAAiE;IAC7E,SAAS,EAAE,mEAAmE;IAC9E,SAAS,EAAE,uDAAuD;IAClE,OAAO,EAAE,yCAAyC;IAClD,OAAO,EAAE,oEAAoE;IAC7E,SAAS,EAAE,sEAAsE;IACjF,WAAW,EAAE,wCAAwC;
|
|
1
|
+
{"version":3,"file":"contract.js","sourceRoot":"","sources":["../src/contract.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAGH,MAAM,CAAC,MAAM,QAAQ,GAAuB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;AAG1H,MAAM,CAAC,MAAM,SAAS,GAAwB,CAAC,CAAC,CAAC,CAAC;AAGlD,MAAM,CAAC,MAAM,iBAAiB,GAA+B,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AAGvF,MAAM,CAAC,MAAM,UAAU,GAAwB,CAAC,QAAQ,CAAC,CAAC;AAG1D,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,YAAY,CAAC,CAAC;AAGhE,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,cAAc,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAG3F,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAG1E,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAGtG,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAAC,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAG1F,MAAM,CAAC,MAAM,wBAAwB,GAAqC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAG5F,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAAC,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;AAGlI,MAAM,CAAC,MAAM,eAAe,GAA6B,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;AAGtF,MAAM,CAAC,MAAM,iBAAiB,GAA+B,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAG/E,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAGxG,MAAM,CAAC,MAAM,kBAAkB,GAA+B,CAAC,MAAM,EAAE,UAAU,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAG3G,MAAM,CAAC,MAAM,UAAU,GAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAG1E,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AAG5E,MAAM,CAAC,MAAM,MAAM,GAAqB,CAAC,eAAe,EAAE,gBAAgB,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,YAAY,EAAE,aAAa,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,gBAAgB,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,WAAW,EAAE,YAAY,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,eAAe,EAAE,cAAc,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,iBAAiB,CAAC,CAAC;AAGpmB,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;AAGnF,MAAM,CAAC,MAAM,iBAAiB,GAA8B,CAAC,QAAQ,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,YAAY,EAAE,aAAa,EAAE,YAAY,CAAC,CAAC;AAG1K,MAAM,CAAC,MAAM,UAAU,GAAwB,CAAC,MAAM,EAAE,gBAAgB,EAAE,YAAY,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,CAAC,CAAC;AAG5H,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;AAGjI,MAAM,CAAC,MAAM,KAAK,GAAoB,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAGxG,MAAM,CAAC,MAAM,aAAa,GAA2B,CAAC,QAAQ,CAAC,CAAC;AAGhE,MAAM,CAAC,MAAM,mBAAmB,GAAiC,CAAC,gBAAgB,CAAC,CAAC;AAGpF,MAAM,CAAC,MAAM,aAAa,GAA2B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;AAG7E,MAAM,CAAC,MAAM,YAAY,GAA0B,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;AAG7F,MAAM,CAAC,MAAM,WAAW,GAAyB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;AAGxE,MAAM,CAAC,MAAM,aAAa,GAA2B,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;AAGlF,MAAM,CAAC,MAAM,iBAAiB,GAA+B,CAAC,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,aAAa,CAAC,CAAC;AAG3G,MAAM,CAAC,MAAM,cAAc,GAA4B,CAAC,SAAS,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,WAAW,EAAE,iBAAiB,CAAC,CAAC;AAEvI,0EAA0E;AAC1E,MAAM,CAAC,MAAM,IAAI,GAAG;IAClB,WAAW,EAAE,EAAE;IACf,mBAAmB,EAAE,EAAE;IACvB,YAAY,EAAE,EAAE;IAChB,oBAAoB,EAAE,GAAG;IACzB,eAAe,EAAE,GAAG;IACpB,UAAU,EAAE,EAAE;IACd,eAAe,EAAE,EAAE;IACnB,oBAAoB,EAAE,GAAG;IACzB,aAAa,EAAE,EAAE;IACjB,gBAAgB,EAAE,EAAE;IACpB,aAAa,EAAE,EAAE;IACjB,OAAO,EAAE,EAAE;IACX,eAAe,EAAE,CAAC;IAClB,SAAS,EAAE,EAAE;IACb,iBAAiB,EAAE,EAAE;IACrB,kBAAkB,EAAE,EAAE;IACtB,KAAK,EAAE,EAAE;IACT,gBAAgB,EAAE,CAAC;IACnB,MAAM,EAAE,EAAE;IACV,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,EAAE;IACX,SAAS,EAAE,EAAE;IACb,SAAS,EAAE,CAAC;IACZ,cAAc,EAAE,CAAC;IACjB,cAAc,EAAE,EAAE;IAClB,iBAAiB,EAAE,EAAE;IACrB,kBAAkB,EAAE,IAAI;IACxB,oBAAoB,EAAE,GAAG;IACzB,qBAAqB,EAAE,EAAE;IACzB,sBAAsB,EAAE,KAAK;IAC7B,mBAAmB,EAAE,GAAG;IACxB,oBAAoB,EAAE,OAAO;IAC7B,YAAY,EAAE,GAAG;IACjB,kBAAkB,EAAE,CAAC;IACrB,QAAQ,EAAE,EAAE;IACZ,wBAAwB,EAAE,EAAE;IAC5B,UAAU,EAAE,IAAI;IAChB,iBAAiB,EAAE,CAAC;IACpB,gBAAgB,EAAE,EAAE;IACpB,oBAAoB,EAAE,EAAE;IACxB,sBAAsB,EAAE,EAAE;IAC1B,gBAAgB,EAAE,EAAE;IACpB,cAAc,EAAE,GAAG;IACnB,UAAU,EAAE,GAAG;IACf,gBAAgB,EAAE,GAAG;IACrB,UAAU,EAAE,GAAG;IACf,WAAW,EAAE,GAAG;IAChB,UAAU,EAAE,GAAG;IACf,iBAAiB,EAAE,GAAG;IACtB,gBAAgB,EAAE,IAAI;IACtB,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,GAAG;IACf,OAAO,EAAE,EAAE;IACX,eAAe,EAAE,KAAK;IACtB,iBAAiB,EAAE,KAAK;IACxB,eAAe,EAAE,KAAK;IACtB,sBAAsB,EAAE,MAAM;IAC9B,aAAa,EAAE,EAAE;IACjB,mBAAmB,EAAE,GAAG;IACxB,SAAS,EAAE,GAAG;IACd,eAAe,EAAE,EAAE;IACnB,uBAAuB,EAAE,GAAG;IAC5B,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,EAAE;IACnB,gBAAgB,EAAE,CAAC;IACnB,YAAY,EAAE,EAAE;IAChB,SAAS,EAAE,CAAC;IACZ,kBAAkB,EAAE,CAAC;IACrB,kBAAkB,EAAE,IAAI;IACxB,mBAAmB,EAAE,CAAC;IACtB,KAAK,EAAE,CAAC;IACR,UAAU,EAAE,GAAG;IACf,KAAK,EAAE,CAAC;IACR,QAAQ,EAAE,EAAE;IACZ,OAAO,EAAE,GAAG;IACZ,YAAY,EAAE,EAAE;IAChB,cAAc,EAAE,EAAE;IAClB,UAAU,EAAE,EAAE;IACd,gBAAgB,EAAE,EAAE;IACpB,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,EAAE;IACnB,YAAY,EAAE,EAAE;IAChB,UAAU,EAAE,GAAG;IACf,gBAAgB,EAAE,KAAK;IACvB,aAAa,EAAE,KAAK;IACpB,gBAAgB,EAAE,IAAI;IACtB,eAAe,EAAE,GAAG;IACpB,qBAAqB,EAAE,OAAO;IAC9B,iBAAiB,EAAE,EAAE;IACrB,eAAe,EAAE,EAAE;CACX,CAAC;AAEX,uDAAuD;AACvD,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,UAAU,EAAE,wCAAwC;IACpD,YAAY,EAAE,yCAAyC;IACvD,QAAQ,EAAE,yCAAyC;IACnD,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,oEAAoE;IAC1E,UAAU,EAAE,iEAAiE;IAC7E,SAAS,EAAE,mEAAmE;IAC9E,SAAS,EAAE,uDAAuD;IAClE,OAAO,EAAE,yCAAyC;IAClD,OAAO,EAAE,oEAAoE;IAC7E,SAAS,EAAE,sEAAsE;IACjF,WAAW,EAAE,wCAAwC;IACrD,kBAAkB,EAAE,sCAAsC;CAClD,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,QAAQ,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC9B,UAAU,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC;IAC7B,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,CAAC;IAC3E,MAAM,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;IACpC,WAAW,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC;IACjD,sBAAsB,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;IACjD,iBAAiB,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,qBAAqB,EAAE,gBAAgB,CAAC;IACrF,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,CAAC;IACtF,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC;IACtD,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,CAAC;IACxF,cAAc,EAAE,CAAC,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,EAAE,kBAAkB,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,YAAY,CAAC;IAClL,eAAe,EAAE,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC;IAC3F,QAAQ,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC;IAC1D,aAAa,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,CAAC;IACnE,YAAY,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC;IACvD,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,CAAC;IACxD,QAAQ,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,mBAAmB,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC;IACvO,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,aAAa,EAAE,UAAU,CAAC;IAC/E,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,cAAc,EAAE,UAAU,CAAC;IAChF,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,CAAC;IACpG,UAAU,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC9B,UAAU,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC;IAC1C,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC;IACxC,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC5B,SAAS,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IAC7B,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,UAAU,CAAC;IAC7D,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC;IACxG,MAAM,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC;IACnC,cAAc,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC;IACrD,WAAW,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC;IACpE,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,UAAU,CAAC;IACtE,gBAAgB,EAAE,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,QAAQ,EAAE,SAAS,CAAC;IAClF,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC;IAClE,gBAAgB,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;IACjC,UAAU,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAChC,aAAa,EAAE,CAAC,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,QAAQ,CAAC;IAC/F,cAAc,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC;IACtC,gBAAgB,EAAE,CAAC,QAAQ,EAAE,cAAc,CAAC;IAC5C,WAAW,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;IAChC,gBAAgB,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC;IACxG,gBAAgB,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC;IAC5D,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC;IAC7F,SAAS,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC;IACrC,YAAY,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC;IAChE,gBAAgB,EAAE,CAAC,SAAS,EAAE,OAAO,EAAE,QAAQ,CAAC;IAChD,WAAW,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC;IACxC,YAAY,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC;IAC9C,aAAa,EAAE,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC;IAC9C,QAAQ,EAAE,CAAC,aAAa,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,gBAAgB,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE,mBAAmB,EAAE,SAAS,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,CAAC;CAC5R,CAAC"}
|
package/dist/define.d.ts
CHANGED
|
@@ -12,16 +12,17 @@
|
|
|
12
12
|
*
|
|
13
13
|
* A declarative plug-in gives each endpoint a `request` (or `steps`) and a `map`
|
|
14
14
|
* in place of a handler, and names its `hosts`: Initiative then makes the
|
|
15
|
-
* calls and maps the answers itself, and there is no service to run.
|
|
16
|
-
*
|
|
15
|
+
* calls and maps the answers itself, and there is no service to run. Its
|
|
16
|
+
* schedules, actions and webhook events say in a `write` how Initiative changes
|
|
17
|
+
* the values it keeps on items. One plug-in is one kind or the other.
|
|
17
18
|
*
|
|
18
19
|
* Endpoints are named by their key. The manifest id is `plugin.<publicId>.<key>`,
|
|
19
20
|
* and everywhere a definition refers to an endpoint (a widget, a sample, a
|
|
20
21
|
* parameter's `options_from`, a bundled dashboard, `communitySummary`, an
|
|
21
|
-
* action) it uses the key.
|
|
22
|
+
* action, a schedule) it uses the key.
|
|
22
23
|
*/
|
|
23
24
|
import type { CommunityStatus } from "./tokens.js";
|
|
24
|
-
import type { Action, ActorKind, PluginScope, BundledDashboard, BundledDashboardWidget, Connection, Page, Endpoint, EndpointParam, EndpointReturn, ErrorRule, Expression, Field, ItemKind, Manifest, Part, RequestStep, ReturnValueType, Scope, Vendor, VendorAuth, VendorRequest, WebhookEvent, Webhooks, Widget } from "./contract.js";
|
|
25
|
+
import type { Action, ActorKind, PluginScope, BundledDashboard, BundledDashboardWidget, Connection, Page, Endpoint, EndpointParam, EndpointReturn, ErrorRule, Expression, Field, ItemKind, Manifest, Part, RequestStep, ReturnValueType, Scope, Setting, Vendor, VendorAuth, VendorRequest, WebhookEvent, Webhooks, Widget } from "./contract.js";
|
|
25
26
|
import type { Client } from "./client.js";
|
|
26
27
|
/**
|
|
27
28
|
* What every handler is handed as `context`: the value given to `createPlugin`.
|
|
@@ -194,9 +195,11 @@ export interface CommunityStatusCall extends Call {
|
|
|
194
195
|
status: CommunityStatus;
|
|
195
196
|
}
|
|
196
197
|
/**
|
|
197
|
-
* What `entitlement` is sent:
|
|
198
|
-
* of
|
|
199
|
-
*
|
|
198
|
+
* What `entitlement` is sent: billing's statement of what this community holds
|
|
199
|
+
* of the plug-in. Billing signs it, Initiative hands it on verbatim, and the
|
|
200
|
+
* SDK verifies it against billing's key (the runtime fact
|
|
201
|
+
* `entitlement_issuer_key`) before the hook runs; a statement that does not
|
|
202
|
+
* verify never reaches it. On a deployment without billing, it is never sent.
|
|
200
203
|
*/
|
|
201
204
|
export interface EntitlementCall extends Call {
|
|
202
205
|
/**
|
|
@@ -207,7 +210,7 @@ export interface EntitlementCall extends Call {
|
|
|
207
210
|
version: number;
|
|
208
211
|
/**
|
|
209
212
|
* The statement itself, replacing the last one whole. Its keys are agreed
|
|
210
|
-
* between your plug-in and
|
|
213
|
+
* between your plug-in and billing; Initiative carries them unread.
|
|
211
214
|
*/
|
|
212
215
|
values: Record<string, unknown>;
|
|
213
216
|
}
|
|
@@ -241,6 +244,18 @@ export interface ScheduleDeclaration {
|
|
|
241
244
|
every: `${number}${"m" | "h"}`;
|
|
242
245
|
run: (call: ScheduleCall) => Promise<void>;
|
|
243
246
|
}
|
|
247
|
+
/**
|
|
248
|
+
* A declarative plug-in's schedule: Initiative makes a read endpoint's call as
|
|
249
|
+
* the installation, and changes the plug-in's values from its answer.
|
|
250
|
+
*/
|
|
251
|
+
export interface DeclarativeScheduleDeclaration<E> extends Pick<ScheduleDeclaration, "every"> {
|
|
252
|
+
/** A read endpoint, by its key, whose `actors` include `installation`. */
|
|
253
|
+
endpoint: ReadName<E>;
|
|
254
|
+
/** The endpoint's params, from `since`, `now`, `connection`, `settings` and `aliases`. */
|
|
255
|
+
params?: Expression;
|
|
256
|
+
/** The targeted changes made from the endpoint's answer, `result`, beside `since`, `now`, `settings` and `aliases`. */
|
|
257
|
+
write: Expression;
|
|
258
|
+
}
|
|
244
259
|
/** A member opening one of the plug-in's pages, as the handoff token names them. */
|
|
245
260
|
export interface Handoff extends Call {
|
|
246
261
|
page: string;
|
|
@@ -279,11 +294,21 @@ type EmitName<E> = {
|
|
|
279
294
|
direction: "emit";
|
|
280
295
|
} ? K : never;
|
|
281
296
|
}[keyof E] & string;
|
|
282
|
-
/**
|
|
297
|
+
/**
|
|
298
|
+
* The vendor's webhooks. A declarative plug-in's event rows name the emit
|
|
299
|
+
* endpoint by its key, beside the `map` of its payload, and may `write` the
|
|
300
|
+
* plug-in's values; a row does one or both.
|
|
301
|
+
*/
|
|
283
302
|
export type WebhooksDeclaration<E> = Omit<Webhooks, "events"> & {
|
|
284
|
-
events?: Array<Omit<WebhookEvent, "emit"> & {
|
|
303
|
+
events?: Array<Omit<WebhookEvent, "emit" | "map" | "write"> & ({
|
|
285
304
|
emit: EmitName<E>;
|
|
286
|
-
|
|
305
|
+
map: Expression;
|
|
306
|
+
write?: Expression;
|
|
307
|
+
} | {
|
|
308
|
+
emit?: never;
|
|
309
|
+
map?: never;
|
|
310
|
+
write: Expression;
|
|
311
|
+
})>;
|
|
287
312
|
};
|
|
288
313
|
type ReturnsOf<X> = X extends {
|
|
289
314
|
returns?: infer R;
|
|
@@ -302,10 +327,21 @@ export interface WidgetDeclaration<E> extends Omit<Widget, "id" | "module_source
|
|
|
302
327
|
[K in ReadName<E>]?: Result<ReturnsOf<E[K]>>;
|
|
303
328
|
};
|
|
304
329
|
}
|
|
305
|
-
/**
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
330
|
+
/**
|
|
331
|
+
* Something a reader runs on one item. `endpoint` names an endpoint by its key,
|
|
332
|
+
* and `params` the endpoint's params Initiative asks the reader for. A
|
|
333
|
+
* container's action names a write; a declarative plug-in's names a read or a
|
|
334
|
+
* write, a `write`, or both.
|
|
335
|
+
*/
|
|
336
|
+
export type ActionDeclaration<E> = Omit<Action, "id" | "endpoint" | "params" | "write"> & ({
|
|
337
|
+
endpoint: WriteName<E> | ReadName<E>;
|
|
338
|
+
params?: Action["params"];
|
|
339
|
+
write?: Expression;
|
|
340
|
+
} | {
|
|
341
|
+
endpoint?: never;
|
|
342
|
+
params?: never;
|
|
343
|
+
write: Expression;
|
|
344
|
+
});
|
|
309
345
|
export interface DashboardDeclaration<E, W> extends Omit<BundledDashboard, "widgets"> {
|
|
310
346
|
widgets: Array<Omit<BundledDashboardWidget, "type" | "binding"> & {
|
|
311
347
|
type: keyof W & string;
|
|
@@ -385,7 +421,14 @@ export type RuntimeFact =
|
|
|
385
421
|
/** This plug-in's own origin, where it serves framed pages (needs `pages`). */
|
|
386
422
|
| "page_origin"
|
|
387
423
|
/** The port below. */
|
|
388
|
-
| "port"
|
|
424
|
+
| "port"
|
|
425
|
+
/**
|
|
426
|
+
* Billing's public key for entitlement statements (SPKI PEM), absent when the
|
|
427
|
+
* deployment runs no billing. Added by the build, under
|
|
428
|
+
* `INITIATIVE_ENTITLEMENT_ISSUER_KEY_PEM`, to every plug-in with an
|
|
429
|
+
* `entitlement` hook.
|
|
430
|
+
*/
|
|
431
|
+
| "entitlement_issuer_key";
|
|
389
432
|
export interface RuntimeDeclaration {
|
|
390
433
|
/** Its short name in a deployment: a DNS label of at most 20 characters, unique in a package. */
|
|
391
434
|
name: string;
|
|
@@ -440,17 +483,6 @@ export interface RuntimeDeclaration {
|
|
|
440
483
|
path: string;
|
|
441
484
|
tokenEnv: string;
|
|
442
485
|
};
|
|
443
|
-
/** Shared secrets with Initiative's own services, honoured for a deployment's own publishers only. */
|
|
444
|
-
integrations?: {
|
|
445
|
-
billing?: {
|
|
446
|
-
hmacEnv: string;
|
|
447
|
-
hmacPreviousEnv?: string;
|
|
448
|
-
publicKeyEnv: string;
|
|
449
|
-
};
|
|
450
|
-
bundledChannel?: {
|
|
451
|
-
env: string;
|
|
452
|
-
};
|
|
453
|
-
};
|
|
454
486
|
}
|
|
455
487
|
export interface PluginDefinition<E, W> {
|
|
456
488
|
/** `<publisher>.<slug>`. */
|
|
@@ -468,7 +500,14 @@ export interface PluginDefinition<E, W> {
|
|
|
468
500
|
* `listing.minAppVersion`, the oldest Initiative release it runs on.
|
|
469
501
|
*/
|
|
470
502
|
minPluginApi?: string;
|
|
503
|
+
/** The scopes it asks a community to grant. A declarative plug-in asks only for read scopes. */
|
|
471
504
|
scopes?: Array<Scope | PluginScope>;
|
|
505
|
+
/**
|
|
506
|
+
* A container plug-in may act through any plug-in the community lets it use,
|
|
507
|
+
* not only those its `plugins:` scopes name (the manifest's
|
|
508
|
+
* `service.calls_plugins`).
|
|
509
|
+
*/
|
|
510
|
+
callsPlugins?: boolean;
|
|
472
511
|
/** A declarative plug-in's hosts: every host its requests may reach. Naming them makes the plug-in declarative. */
|
|
473
512
|
hosts?: string[];
|
|
474
513
|
/** How a declarative plug-in's requests carry their credential. Absent: `Authorization: Bearer <token>`. */
|
|
@@ -477,8 +516,11 @@ export interface PluginDefinition<E, W> {
|
|
|
477
516
|
/** Keyed by connection id. */
|
|
478
517
|
connections?: Record<string, Omit<Connection, "id">>;
|
|
479
518
|
webhooks?: WebhooksDeclaration<E>;
|
|
480
|
-
/**
|
|
481
|
-
|
|
519
|
+
/**
|
|
520
|
+
* Keyed by schedule id. A container's runs through the `schedule` hook; a
|
|
521
|
+
* declarative plug-in's is a read and a write Initiative makes.
|
|
522
|
+
*/
|
|
523
|
+
schedules?: Record<string, ScheduleDeclaration | DeclarativeScheduleDeclaration<E>>;
|
|
482
524
|
endpoints?: E;
|
|
483
525
|
/** A read endpoint describing the community's standing with the plug-in's service. */
|
|
484
526
|
communitySummary?: ReadName<E>;
|
|
@@ -493,6 +535,10 @@ export interface PluginDefinition<E, W> {
|
|
|
493
535
|
parts?: Record<string, Omit<Part, "id">>;
|
|
494
536
|
/** What a reader may run on an item, keyed by action id. */
|
|
495
537
|
actions?: Record<string, ActionDeclaration<E>>;
|
|
538
|
+
/** Values the community's admins set on the install, keyed by setting key. */
|
|
539
|
+
settings?: Record<string, Omit<Setting, "key">>;
|
|
540
|
+
/** Help with the plug-in's parts and settings: markdown, keyed by language tag. */
|
|
541
|
+
help?: Manifest["help"];
|
|
496
542
|
listing?: ListingDeclaration;
|
|
497
543
|
}
|
|
498
544
|
/** Any plug-in's definition, as the server and the build read it. */
|
|
@@ -509,8 +555,9 @@ export declare function endpointId(plugin: {
|
|
|
509
555
|
/**
|
|
510
556
|
* The manifest a definition declares: its handlers left out, its keys made
|
|
511
557
|
* ids, in the contract's order. Each widget's `module_source` is taken from
|
|
512
|
-
* `modules` by widget id. A definition naming `hosts` is declarative
|
|
513
|
-
* manifest has no `service` block.
|
|
558
|
+
* `modules` by widget id. A definition naming `hosts` is declarative: its
|
|
559
|
+
* manifest has no `service` block, and its `scopes` stand at the top level.
|
|
560
|
+
* A container's `callsPlugins` is its service block's `calls_plugins`.
|
|
514
561
|
*/
|
|
515
562
|
export declare function manifestOf(plugin: AnyPlugin, modules?: Record<string, string>): Manifest;
|
|
516
563
|
export {};
|
package/dist/define.js
CHANGED
|
@@ -12,13 +12,14 @@
|
|
|
12
12
|
*
|
|
13
13
|
* A declarative plug-in gives each endpoint a `request` (or `steps`) and a `map`
|
|
14
14
|
* in place of a handler, and names its `hosts`: Initiative then makes the
|
|
15
|
-
* calls and maps the answers itself, and there is no service to run.
|
|
16
|
-
*
|
|
15
|
+
* calls and maps the answers itself, and there is no service to run. Its
|
|
16
|
+
* schedules, actions and webhook events say in a `write` how Initiative changes
|
|
17
|
+
* the values it keeps on items. One plug-in is one kind or the other.
|
|
17
18
|
*
|
|
18
19
|
* Endpoints are named by their key. The manifest id is `plugin.<publicId>.<key>`,
|
|
19
20
|
* and everywhere a definition refers to an endpoint (a widget, a sample, a
|
|
20
21
|
* parameter's `options_from`, a bundled dashboard, `communitySummary`, an
|
|
21
|
-
* action) it uses the key.
|
|
22
|
+
* action, a schedule) it uses the key.
|
|
22
23
|
*/
|
|
23
24
|
import { FEATURES } from "./contract.js";
|
|
24
25
|
export function defineEndpoint(endpoint) {
|
|
@@ -37,8 +38,9 @@ export function endpointId(plugin, name) {
|
|
|
37
38
|
/**
|
|
38
39
|
* The manifest a definition declares: its handlers left out, its keys made
|
|
39
40
|
* ids, in the contract's order. Each widget's `module_source` is taken from
|
|
40
|
-
* `modules` by widget id. A definition naming `hosts` is declarative
|
|
41
|
-
* manifest has no `service` block.
|
|
41
|
+
* `modules` by widget id. A definition naming `hosts` is declarative: its
|
|
42
|
+
* manifest has no `service` block, and its `scopes` stand at the top level.
|
|
43
|
+
* A container's `callsPlugins` is its service block's `calls_plugins`.
|
|
42
44
|
*/
|
|
43
45
|
export function manifestOf(plugin, modules = {}) {
|
|
44
46
|
const id = (name) => endpointId(plugin, name);
|
|
@@ -47,9 +49,11 @@ export function manifestOf(plugin, modules = {}) {
|
|
|
47
49
|
connections: listOf(plugin.connections, (key, connection) => ({ id: key, ...connection })),
|
|
48
50
|
webhooks: plugin.webhooks && {
|
|
49
51
|
...plugin.webhooks,
|
|
50
|
-
...(plugin.webhooks.events
|
|
52
|
+
...(plugin.webhooks.events
|
|
53
|
+
? { events: plugin.webhooks.events.map((event) => (event.emit === undefined ? event : { ...event, emit: id(event.emit) })) }
|
|
54
|
+
: {}),
|
|
51
55
|
},
|
|
52
|
-
schedules: listOf(plugin.schedules, (key, schedule) =>
|
|
56
|
+
schedules: listOf(plugin.schedules, (key, schedule) => "run" in schedule ? { id: key, every: schedule.every } : { id: key, ...schedule, endpoint: id(schedule.endpoint) }),
|
|
53
57
|
endpoints: listOf(plugin.endpoints, (key, endpoint) => endpointOf(id(key), endpoint, id)),
|
|
54
58
|
community_summary: plugin.communitySummary === undefined ? undefined : id(plugin.communitySummary),
|
|
55
59
|
widgets: listOf(plugin.widgets, (key, widget) => widgetOf(key, widget, modules[key] ?? "", id)),
|
|
@@ -66,20 +70,34 @@ export function manifestOf(plugin, modules = {}) {
|
|
|
66
70
|
})),
|
|
67
71
|
fields: listOf(plugin.fields, (key, field) => ({ key, ...field })),
|
|
68
72
|
parts: listOf(plugin.parts, (key, part) => ({ id: key, ...part })),
|
|
69
|
-
actions: listOf(plugin.actions, (key, action) => ({
|
|
73
|
+
actions: listOf(plugin.actions, (key, action) => ({
|
|
74
|
+
id: key,
|
|
75
|
+
...action,
|
|
76
|
+
...(action.endpoint === undefined ? {} : { endpoint: id(action.endpoint) }),
|
|
77
|
+
})),
|
|
78
|
+
settings: listOf(plugin.settings, (key, setting) => ({ key, ...setting })),
|
|
79
|
+
help: plugin.help,
|
|
70
80
|
};
|
|
71
81
|
const present = Object.fromEntries(Object.entries(blocks).filter(([, value]) => value !== undefined));
|
|
72
82
|
return {
|
|
73
83
|
plugin_kind: "service",
|
|
74
84
|
...(plugin.hosts
|
|
75
85
|
? {}
|
|
76
|
-
: {
|
|
86
|
+
: {
|
|
87
|
+
service: {
|
|
88
|
+
public_id: plugin.publicId,
|
|
89
|
+
protocol: 1,
|
|
90
|
+
...(plugin.scopes ? { scopes: [...plugin.scopes] } : {}),
|
|
91
|
+
...(plugin.callsPlugins !== undefined ? { calls_plugins: plugin.callsPlugins } : {}),
|
|
92
|
+
},
|
|
93
|
+
}),
|
|
77
94
|
features: FEATURES.filter((feature) => present[feature] !== undefined),
|
|
78
95
|
default_name: plugin.name,
|
|
79
96
|
...(plugin.minimumAge ? { minimum_age: { ...plugin.minimumAge } } : {}),
|
|
80
97
|
...(plugin.minPluginApi !== undefined ? { min_plugin_api: plugin.minPluginApi } : {}),
|
|
81
98
|
...(plugin.hosts ? { hosts: [...plugin.hosts] } : {}),
|
|
82
99
|
...(plugin.auth ? { auth: plugin.auth } : {}),
|
|
100
|
+
...(plugin.hosts && plugin.scopes ? { scopes: [...plugin.scopes] } : {}),
|
|
83
101
|
...present,
|
|
84
102
|
};
|
|
85
103
|
}
|
package/dist/define.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"define.js","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"define.js","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AA+BH,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AA+IzC,MAAM,UAAU,cAAc,CAAC,QAA6B;IAC1D,OAAO,QAAQ,CAAC;AAClB,CAAC;AAsED,oFAAoF;AACpF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,OAAO,EAAE,kBAAkB,EAAE,aAAa,CAAU,CAAC;AAqTjH,kCAAkC;AAClC,MAAM,UAAU,YAAY,CAG1B,UAAkC;IAClC,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,iCAAiC;AACjC,MAAM,UAAU,UAAU,CAAC,MAA4B,EAAE,IAAY;IACnE,OAAO,UAAU,MAAM,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,MAAiB,EAAE,OAAO,GAA2B,EAAE;IAChF,MAAM,EAAE,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACtD,MAAM,MAAM,GAAsB;QAChC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC;QAC1F,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI;YAC3B,GAAG,MAAM,CAAC,QAAQ;YAClB,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM;gBACxB,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE;gBAC5H,CAAC,CAAC,EAAE,CAAC;SACR;QACD,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CACpD,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CACnH;QACD,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QACzF,iBAAiB,EAAE,MAAM,CAAC,gBAAgB,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC;QAClG,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC/F,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YACxC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC;YAChD,OAAO,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAClC,CAAC,CAAC;QACF,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YACjD,GAAG,SAAS;YACZ,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;gBAC1C,GAAG,MAAM;gBACT,OAAO,EAAE,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;aAC5E,CAAC,CAAC;SACJ,CAAC,CAAC;QACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;QAClE,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC;QAClE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;YAChD,EAAE,EAAE,GAAG;YACP,GAAG,MAAM;YACT,GAAG,CAAC,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;SAC5E,CAAC,CAAC;QACH,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAC1E,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAC;IACF,MAAM,OAAO,GAAG,MAAM,CAAC,WAAW,CAChC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAC7C,CAAC;IACvB,OAAO;QACL,WAAW,EAAE,SAAS;QACtB,GAAG,CAAC,MAAM,CAAC,KAAK;YACd,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC;gBACE,OAAO,EAAE;oBACP,SAAS,EAAE,MAAM,CAAC,QAAQ;oBAC1B,QAAQ,EAAE,CAAC;oBACX,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;oBACxD,GAAG,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACrF;aACF,CAAC;QACN,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC;QACtE,YAAY,EAAE,MAAM,CAAC,IAAI;QACzB,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,GAAG,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvE,GAAG,CAAC,MAAM,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrF,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACrD,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,GAAG,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,GAAG,OAAO;KACX,CAAC;AACJ,CAAC;AAED,qEAAqE;AACrE,SAAS,MAAM,CAAO,MAAqC,EAAE,KAAmC;IAC9F,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;IAC7C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACvF,CAAC;AAED,yEAAyE;AACzE,SAAS,UAAU,CAAC,eAAuB,EAAE,QAA6B,EAAE,EAA4B;IACtG,MAAM,GAAG,GAA4B,EAAE,EAAE,EAAE,eAAe,EAAE,CAAC;IAC7D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACpD,IAAI,GAAG,KAAK,SAAS;YAAE,SAAS;QAChC,IAAI,GAAG,KAAK,QAAQ,EAAE,CAAC;YACrB,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,KAAkC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC;gBACtF,GAAG,EAAE,IAAI;gBACT,GAAG,KAAK;gBACR,GAAG,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,KAAK,CAAC,YAAY,EAAE,QAAQ,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aACtH,CAAC,CAAC,CAAC;QACN,CAAC;aAAM,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;YAC7B,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAmC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,CACrF,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAC9E,CAAC;QACJ,CAAC;;YAAM,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IAC1B,CAAC;IACD,OAAO,GAA0B,CAAC;AACpC,CAAC;AAED,SAAS,QAAQ,CACf,GAAW,EACX,MAA8B,EAC9B,MAAc,EACd,EAA4B;IAE5B,MAAM,GAAG,GAA4B,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC;IACjD,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACpD,IAAI,KAAK,KAAK,QAAQ;YAAE,GAAG,CAAC,aAAa,GAAG,MAAM,CAAC;aAC9C,IAAI,KAAK,KAAK,WAAW;YAAE,GAAG,CAAC,SAAS,GAAI,KAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;aACvE,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;YACjC,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;QACpH,CAAC;;YAAM,GAAG,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC;IAC5B,CAAC;IACD,OAAO,GAAwB,CAAC;AAClC,CAAC"}
|
package/dist/manifest.d.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* which plug-in API contract a manifest's `min_plugin_api` runs on.
|
|
5
5
|
*/
|
|
6
6
|
export * from "./contract.js";
|
|
7
|
-
export { definePlugin, defineEndpoint, type ActionDeclaration, type Actor, type AfterConnectAnswer, type AfterConnectCall, type PluginContext, type PluginDefinition, type Call, type CallableEndpoint, type CommunityHook, type CommunityStatusCall, type EntitlementCall, COMMUNITY_HOOKS, type DashboardDeclaration, type EmittedEndpoint, type EndpointCall, type EndpointDeclaration, type Handoff, type Hooks, type ItemRef, type ListingDeclaration, type Outcome, type PageCall, type PageDeclaration, type Params, type ParamSpec, type ParamValue, type Result, type ReturnSpec, type RevokeCall, type RuntimeDeclaration, type RuntimeFact, type ScheduleCall, type ScheduleDeclaration, type WebhookCall, type WidgetDeclaration, } from "./define.js";
|
|
7
|
+
export { definePlugin, defineEndpoint, type ActionDeclaration, type Actor, type AfterConnectAnswer, type AfterConnectCall, type PluginContext, type PluginDefinition, type Call, type CallableEndpoint, type CommunityHook, type CommunityStatusCall, type EntitlementCall, COMMUNITY_HOOKS, type DashboardDeclaration, type DeclarativeScheduleDeclaration, type EmittedEndpoint, type EndpointCall, type EndpointDeclaration, type Handoff, type Hooks, type ItemRef, type ListingDeclaration, type Outcome, type PageCall, type PageDeclaration, type Params, type ParamSpec, type ParamValue, type Result, type ReturnSpec, type RevokeCall, type RuntimeDeclaration, type RuntimeFact, type ScheduleCall, type ScheduleDeclaration, type WebhookCall, type WidgetDeclaration, } from "./define.js";
|
|
8
8
|
export { MANIFEST_PATH, manifestSchema, validateDocument, validateManifest, type PluginDocument, type ValidationProblem, } from "./validate.js";
|
|
9
9
|
export { pluginApiCompatible } from "./plugin-api.js";
|
|
10
10
|
export type { Jwks, PublicJwk } from "./keys.js";
|
package/dist/manifest.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,eAAe,CAAC;AAE9B,OAAO,EACL,YAAY,EACZ,cAAc,EAYd,eAAe,
|
|
1
|
+
{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,eAAe,CAAC;AAE9B,OAAO,EACL,YAAY,EACZ,cAAc,EAYd,eAAe,GAyBhB,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,gBAAgB,GAGjB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC"}
|