@colixsystems/widget-sdk 0.95.0 → 0.96.0

package/README.md

@@ -66,6 +66,24 @@ See the design reference for the full architecture: [`docs/architecture/widget-m
 
 `v0.91.0` — pre-publish. The package surface (types, function names, export paths) is the v1 contract; runtime behaviour for some hooks is stubbed (each hook documents what's wired and what isn't). It is **not yet published to npm**.
 
+### What's new in 0.96.0 (contract 1.68.0)
+
+**A manifest action can declare `manual`, and every action script gains a `request` global (sc-5366).** The backend Action model grew three ways of *reaching* a script to sit beside the ones that *fire* it: `manual` (nothing starts it — the workspace runs it on demand), `app` (a published app's button `onPress`) and `http_post` (an inbound webhook at `POST /api/v1/action-hooks/:actionId`, authenticated with one of the workspace's integration API keys). The same change retired the separate `appInvokable` boolean, so one column now answers "what starts this action?".
+
+Only `manual` joins `CONTRACT.actionTriggerTypes`, and that is deliberate. `app` and `http_post` expose a script to a caller **outside** the Studio, which is the installing workspace's decision about running someone else's code — not the author's. A manifest that declares either is rejected by `validateManifest`, the CLI linter and the backend alike; the operator grants them in the Actions admin page after install, on top of whatever triggers your manifest declared. Nothing about an already-published manifest changes.
+
+`CONTRACT.actionScriptGlobals` gains **`request`**: `{ body }` — the JSON an inbound webhook caller sent — on an `http_post` run, and `null` on every other trigger. Request *headers* are never passed through, because they carry the caller's API key. `triggerType` now also reports `"http_post"` alongside `"manual"` and `"app"`, so one script can tell a webhook apart from its nightly schedule:
+
+```js
+if (triggerType === "http_post") {
+  const order = request?.body;
+  if (!order?.id) return; // never trust the caller's shape
+  await datastore.records("Orders").create({ externalId: order.id });
+}
+```
+
+`CONTRACT.version` → `1.68.0`. Additive for every existing manifest.
+
 ### What's new in 0.95.0 (contract 1.67.0)
 
 **An admin can mail a locked-out member a password-reset link — `useUsers().sendPasswordReset(userId)` (sc-5335).** An app user who forgot their password could only recover it themselves, from the app's own login screen. The admin they actually ask — the one already able to invite, deactivate and remove them — had no way to help, and the workaround in the field was to remove and re-invite the account, which discards its group memberships and history.

package/dist/contract.cjs

@@ -1459,14 +1459,23 @@ const PLATFORMS = ["web", "native"];
 
 // REQ-WIDGET-ACTION — server-side actions a widget may declare in its
 // manifest. Each runs in the shared isolated-vm action runner (see backend
-// action-runner.service.js) on a cron schedule or in response to a record
-// CRUD event — NEVER in the rendered app, so they never affect Player ↔
-// export parity. The trigger vocabulary mirrors the backend Action model.
+// action-runner.service.js) on a cron schedule, in response to a record CRUD
+// event, or on demand — NEVER in the rendered app, so they never affect
+// Player ↔ export parity.
+//
+// This is what a MANIFEST may declare. The backend Action model additionally
+// accepts 'app' and 'http_post' (sc-5366), which expose a script to a
+// published app's buttons or to a public webhook — those are the installing
+// workspace's decision about running someone else's code, so an operator
+// grants them and a manifest may not ask for them. `validateManifest` and the
+// backend's `_validateWidgetDeclared` both reject them, so the linter and the
+// server agree about what a manifest declared.
 const ACTION_TRIGGER_TYPES = [
   "schedule",
   "record_created",
   "record_updated",
   "record_deleted",
+  "manual",
 ];
 // Globals the action script runs against (the runner's surface) — distinct
 // from the React/SDK widget surface, so the component import/banned-API
@@ -1479,6 +1488,9 @@ const ACTION_SCRIPT_GLOBALS = [
   "notifications",
   "console",
   "record",
+  // sc-5366 — `{ body }` on a run fired by the inbound `http_post` trigger,
+  // null on every other trigger.
+  "request",
   "tenantId",
   "triggerType",
   "triggerTableId",
@@ -2939,7 +2951,12 @@ const CONTRACT = deepFreeze({
   //    resolves `{ sent, email_masked }` and never returns the token or the
   //    link, so it is not an account-takeover primitive; it gates on the same
   //    `users.write:*` scope as invite / deactivate.
-  version: "1.67.0",
+  // 1.68.0: additive (sc-5366) — a manifest action may declare the `manual`
+  //    trigger (nothing fires it; the workspace runs it on demand), and every
+  //    action script now sees a `request` global — `{ body }` on a run fired
+  //    by the workspace-granted `http_post` webhook trigger, null otherwise.
+  //    `app` and `http_post` stay operator-granted and are NOT declarable.
+  version: "1.68.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/contract.js

@@ -1459,14 +1459,23 @@ const PLATFORMS = ["web", "native"];
 
 // REQ-WIDGET-ACTION — server-side actions a widget may declare in its
 // manifest. Each runs in the shared isolated-vm action runner (see backend
-// action-runner.service.js) on a cron schedule or in response to a record
-// CRUD event — NEVER in the rendered app, so they never affect Player ↔
-// export parity. The trigger vocabulary mirrors the backend Action model.
+// action-runner.service.js) on a cron schedule, in response to a record CRUD
+// event, or on demand — NEVER in the rendered app, so they never affect
+// Player ↔ export parity.
+//
+// This is what a MANIFEST may declare. The backend Action model additionally
+// accepts 'app' and 'http_post' (sc-5366), which expose a script to a
+// published app's buttons or to a public webhook — those are the installing
+// workspace's decision about running someone else's code, so an operator
+// grants them and a manifest may not ask for them. `validateManifest` and the
+// backend's `_validateWidgetDeclared` both reject them, so the linter and the
+// server agree about what a manifest declared.
 const ACTION_TRIGGER_TYPES = [
   "schedule",
   "record_created",
   "record_updated",
   "record_deleted",
+  "manual",
 ];
 // Globals the action script runs against (the runner's surface) — distinct
 // from the React/SDK widget surface, so the component import/banned-API
@@ -1479,6 +1488,9 @@ const ACTION_SCRIPT_GLOBALS = [
   "notifications",
   "console",
   "record",
+  // sc-5366 — `{ body }` on a run fired by the inbound `http_post` trigger,
+  // null on every other trigger.
+  "request",
   "tenantId",
   "triggerType",
   "triggerTableId",
@@ -2939,7 +2951,12 @@ const CONTRACT = deepFreeze({
   //    resolves `{ sent, email_masked }` and never returns the token or the
   //    link, so it is not an account-takeover primitive; it gates on the same
   //    `users.write:*` scope as invite / deactivate.
-  version: "1.67.0",
+  // 1.68.0: additive (sc-5366) — a manifest action may declare the `manual`
+  //    trigger (nothing fires it; the workspace runs it on demand), and every
+  //    action script now sees a `request` global — `{ body }` on a run fired
+  //    by the workspace-granted `http_post` webhook trigger, null otherwise.
+  //    `app` and `http_post` stay operator-granted and are NOT declarable.
+  version: "1.68.0",
   sharedTranslationKeys: SHARED_TRANSLATION_KEYS,
   hooks: HOOKS,
   primitives: PRIMITIVES,

package/dist/index.d.ts

@@ -229,17 +229,25 @@ export interface WidgetManifestAction {
    * that actually fired.
    */
   triggerTypes: Array<
-    "schedule" | "record_created" | "record_updated" | "record_deleted"
+    | "schedule"
+    | "record_created"
+    | "record_updated"
+    | "record_deleted"
+    // sc-5366 — nothing fires it; the workspace runs it on demand. The
+    // `"app"` and `"http_post"` triggers are operator-granted, not declarable.
+    | "manual"
   >;
   /** Required iff `triggerTypes` contains `"schedule"`. node-cron syntax. */
   scheduleCron?: string;
   /** 100–300000. Defaults to 30000 on materialise. */
   timeoutMs?: number;
   /**
-   * Runs against `datastore`, `fetch`, `console`, `record`, `tenantId`,
-   * `triggerType`, `triggerTableId` — NOT the React/SDK surface. ≤ 200 KiB.
-   * `triggerType` is the trigger that fired THIS run — one of the declared
-   * `triggerTypes`, or `"manual"` / `"app"` for an operator or button run.
+   * Runs against `datastore`, `fetch`, `console`, `record`, `request`,
+   * `tenantId`, `triggerType`, `triggerTableId` — NOT the React/SDK surface.
+   * ≤ 200 KiB. `triggerType` is the trigger that fired THIS run — one of the
+   * declared `triggerTypes`, or `"manual"` / `"app"` / `"http_post"` for an
+   * operator, button or webhook run. `request` is `{ body }` on a webhook run
+   * and `null` otherwise (sc-5366).
    */
   scriptSource: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colixsystems/widget-sdk",
-  "version": "0.95.0",
+  "version": "0.96.0",
   "description": "Common widget interface for AppStudio. Implements WidgetManifest, WidgetContext, property schema, and helper hooks.",
   "type": "module",
   "main": "./dist/index.js",