@objectstack/plugin-webhooks 16.0.0 → 17.0.0-rc.0

package/src/webhook-outbox-plugin.ts

@@ -5,6 +5,8 @@ import type { IDataEngine, IRealtimeService } from '@objectstack/spec/contracts'
 import type { EnqueueHttpInput } from '@objectstack/service-messaging';
 import { AutoEnqueuer, type AutoEnqueuerOptions } from './auto-enqueuer.js';
 import { SysWebhook } from './sys-webhook.object.js';
+import { bootstrapDeclaredWebhooks } from './bootstrap-declared-webhooks.js';
+import { bindWebhookProvenanceStamp, unbindWebhookProvenanceStamp } from './webhook-provenance.js';
 
 /**
  * Structural view of `@objectstack/service-messaging`'s HTTP-outbox surface
@@ -62,6 +64,8 @@ export class WebhookOutboxPlugin implements Plugin {
     dependencies = ['com.objectstack.service.messaging'];
 
     private autoEnqueuer: AutoEnqueuer | undefined;
+    /** Engine the provenance hook was bound to, so `dispose()` can unbind it. */
+    private boundEngine: any;
 
     constructor(private readonly options: WebhookOutboxPluginOptions = {}) {}
 
@@ -117,6 +121,12 @@ export class WebhookOutboxPlugin implements Plugin {
 
         if (typeof (ctx as any).hook === 'function') {
             (ctx as any).hook('kernel:ready', async () => {
+                // Materialize declared webhooks FIRST — this only needs the data
+                // engine, so it must not be gated behind the auto-enqueue
+                // dispatch prerequisites (realtime + messaging). Otherwise a
+                // deployment without realtime would silently fail to materialize
+                // declared webhooks — the very no-op this bridge closes (#3461).
+                await this.bootDeclaredWebhooks(ctx);
                 await this.bootAutoEnqueue(ctx, autoEnqueueOpt);
                 this.registerAdminRoutes(ctx);
             });
@@ -129,6 +139,10 @@ export class WebhookOutboxPlugin implements Plugin {
 
     async dispose(): Promise<void> {
         await this.autoEnqueuer?.stop();
+        if (this.boundEngine) {
+            try { unbindWebhookProvenanceStamp(this.boundEngine); } catch { /* best effort */ }
+            this.boundEngine = undefined;
+        }
     }
 
     private getMessaging(ctx: PluginContext): MessagingHttpSurface | undefined {
@@ -136,6 +150,38 @@ export class WebhookOutboxPlugin implements Plugin {
         return svc && typeof svc.enqueueHttp === 'function' ? svc : undefined;
     }
 
+    /**
+     * [#3461] Bridge the declarative authoring surface to the dispatcher:
+     * materialize stack/connector-declared `webhook` metadata into `sys_webhook`
+     * rows so the auto-enqueuer (and the Studio UI) can see them.
+     *
+     * Gated on the DATA ENGINE alone — deliberately independent of the
+     * auto-enqueue dispatch prerequisites (realtime + messaging). Materializing
+     * rows is a pure write; a deployment that mounts the webhook plugin without
+     * realtime must still get its declared webhooks into the table (and the
+     * Setup UI), even if nothing dispatches them yet. Runs before
+     * {@link bootAutoEnqueue} so the enqueuer's first cache refresh sees the rows.
+     */
+    private async bootDeclaredWebhooks(ctx: PluginContext): Promise<void> {
+        const engine = this.tryGetService<IDataEngine>(ctx, ['objectql', 'data']);
+        if (!engine) {
+            ctx.logger.warn?.('[webhook] declared-webhook bootstrap skipped — no data engine available');
+            return;
+        }
+        // Bind the provenance stamp so an admin edit freezes a seeded row.
+        this.boundEngine = engine;
+        bindWebhookProvenanceStamp(engine as any, ctx.logger as any);
+        let metadataService: any;
+        try { metadataService = ctx.getService('metadata'); } catch { /* optional */ }
+        try {
+            await bootstrapDeclaredWebhooks(engine, metadataService, ctx.logger as any);
+        } catch (err: any) {
+            ctx.logger.warn?.('[webhook] declared-webhook bootstrap failed (dispatcher still serves admin rows)', {
+                error: err?.message ?? String(err),
+            });
+        }
+    }
+
     private async bootAutoEnqueue(
         ctx: PluginContext,
         opt: boolean | AutoEnqueuerOptions,

package/src/webhook-provenance.ts

@@ -0,0 +1,86 @@
+// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.
+
+/**
+ * [#3461] Provenance stamp for `sys_webhook`.
+ *
+ * `sys_webhook` is RECORD-AUTHORITATIVE: a code-declared webhook is a boot seed
+ * (`bootstrapDeclaredWebhooks`), and the row — including any admin tuning such
+ * as flipping a noisy webhook to `active: false` — is the authority. The seeder
+ * skips rows marked `customized`, so this hook is the half that DETECTS the
+ * admin edit: any non-system update touching a `package`/`platform`-seeded row
+ * stamps `customized: true` onto the payload.
+ *
+ * Why a data hook (and not a write gate or the REST layer), verbatim to the
+ * sys_sharing_rule rationale (#2909 T1):
+ *  - admins edit webhooks through several doors (Setup UI generic data door,
+ *    scripts, console) — an engine hook covers them all;
+ *  - there is deliberately NO write gate here: webhooks are a first-class admin
+ *    authoring surface, so edits are allowed — they just have to be remembered;
+ *  - both provenance columns are `readonly`, and the engine's readonly strip
+ *    exempts isSystem callers while snapshotting supplied keys BEFORE hooks run
+ *    — so a caller can never forge/clear `customized`, while this hook's stamp
+ *    survives.
+ *
+ * Known boundary: multi-row updates (no single `input.id`) are not stamped —
+ * every webhook-editing UI path updates by id.
+ */
+
+interface MinimalEngine {
+  find(object: string, opts?: any): Promise<any[]>;
+  registerHook(event: string, handler: (ctx: any) => any, options?: Record<string, any>): void;
+  unregisterHooksByPackage(packageId: string): number;
+}
+
+interface MinimalLogger {
+  info?: (msg: string, meta?: Record<string, any>) => void;
+  warn?: (msg: string, meta?: Record<string, any>) => void;
+}
+
+export const WEBHOOK_PROVENANCE_PACKAGE = 'plugin-webhooks:provenance';
+
+const SYSTEM_CTX = { isSystem: true, positions: [], permissions: [] } as const;
+
+export function bindWebhookProvenanceStamp(engine: MinimalEngine, logger?: MinimalLogger): void {
+  if (typeof engine?.registerHook !== 'function') return;
+  engine.registerHook(
+    'beforeUpdate',
+    async (ctx: any) => {
+      // Seeder / boot reconcilers write with isSystem — the package door, not
+      // an admin customization.
+      if ((ctx?.session as any)?.isSystem) return;
+      const id = ctx?.input?.id ?? (ctx?.input?.data as any)?.id;
+      if (!id) return; // multi-row update — see boundary note above
+      const data = ctx?.input?.data;
+      if (!data || typeof data !== 'object') return;
+      try {
+        // `previous` is not resolved before beforeUpdate hooks run — read the
+        // current row ourselves (system ctx: this is a provenance check, not
+        // an authorization decision).
+        const rows = await engine.find('sys_webhook', {
+          filter: { id },
+          fields: ['id', 'managed_by', 'customized'],
+          limit: 1,
+          context: SYSTEM_CTX,
+        });
+        const row = Array.isArray(rows) ? rows[0] : undefined;
+        if (!row) return;
+        if ((row.managed_by === 'package' || row.managed_by === 'platform') && row.customized !== true) {
+          (data as any).customized = true;
+        }
+      } catch (err: any) {
+        logger?.warn?.('[webhook] provenance stamp failed (edit proceeds unstamped)', {
+          id,
+          error: err?.message,
+        });
+      }
+    },
+    { object: 'sys_webhook', packageId: WEBHOOK_PROVENANCE_PACKAGE, priority: 150 },
+  );
+  logger?.info?.('[webhook] provenance stamp hook bound');
+}
+
+export function unbindWebhookProvenanceStamp(engine: MinimalEngine): void {
+  if (typeof engine?.unregisterHooksByPackage === 'function') {
+    engine.unregisterHooksByPackage(WEBHOOK_PROVENANCE_PACKAGE);
+  }
+}

package/dist/chunk-PTMJ5BLL.cjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":["/home/runner/work/framework/framework/packages/plugins/plugin-webhooks/dist/chunk-PTMJ5BLL.cjs","../src/sys-webhook.object.ts"],"names":[],"mappings":"AAAA;ACEA,8CAAoC;AA8B7B,IAAM,WAAA,EAAa,kBAAA,CAAa,MAAA,CAAO;AAAA,EAC5C,IAAA,EAAM,aAAA;AAAA,EACN,KAAA,EAAO,SAAA;AAAA,EACP,WAAA,EAAa,UAAA;AAAA,EACb,IAAA,EAAM,SAAA;AAAA,EACN,QAAA,EAAU,IAAA;AAAA,EACV,SAAA,EAAW,QAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMX,WAAA,EAAa,EAAE,MAAA,EAAQ,IAAA,EAAM,IAAA,EAAM,IAAA,EAAM,MAAA,EAAQ,IAAA,EAAM,MAAA,EAAQ,MAAM,CAAA;AAAA,EACrE,WAAA,EAAa,uIAAA;AAAA,EACb,gBAAA,EAAkB,MAAA;AAAA,EAClB,SAAA,EAAW,MAAA;AAAA;AAAA,EACX,WAAA,EAAa,SAAA;AAAA,EACb,eAAA,EAAiB,CAAC,MAAA,EAAQ,aAAA,EAAe,KAAA,EAAO,QAAA,EAAU,YAAY,CAAA;AAAA,EAEtE,SAAA,EAAW;AAAA,IACT,MAAA,EAAQ;AAAA,MACN,IAAA,EAAM,MAAA;AAAA,MACN,IAAA,EAAM,QAAA;AAAA,MACN,KAAA,EAAO,QAAA;AAAA,MACP,IAAA,EAAM,EAAE,QAAA,EAAU,QAAA,EAAU,MAAA,EAAQ,cAAc,CAAA;AAAA,MAClD,OAAA,EAAS,CAAC,OAAA,EAAS,aAAA,EAAe,KAAA,EAAO,QAAA,EAAU,QAAA,EAAU,YAAY,CAAA;AAAA,MACzE,MAAA,EAAQ,CAAC,EAAE,KAAA,EAAO,QAAA,EAAU,QAAA,EAAU,QAAA,EAAU,KAAA,EAAO,KAAK,CAAC,CAAA;AAAA,MAC7D,IAAA,EAAM,CAAC,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,MAAM,CAAC,CAAA;AAAA,MACvC,UAAA,EAAY,EAAE,QAAA,EAAU,GAAG;AAAA,IAC7B,CAAA;AAAA,IACA,QAAA,EAAU;AAAA,MACR,IAAA,EAAM,MAAA;AAAA,MACN,IAAA,EAAM,UAAA;AAAA,MACN,KAAA,EAAO,UAAA;AAAA,MACP,IAAA,EAAM,EAAE,QAAA,EAAU,QAAA,EAAU,MAAA,EAAQ,cAAc,CAAA;AAAA,MAClD,OAAA,EAAS,CAAC,OAAA,EAAS,aAAA,EAAe,KAAA,EAAO,QAAA,EAAU,QAAA,EAAU,YAAY,CAAA;AAAA,MACzE,MAAA,EAAQ,CAAC,EAAE,KAAA,EAAO,QAAA,EAAU,QAAA,EAAU,QAAA,EAAU,KAAA,EAAO,MAAM,CAAC,CAAA;AAAA,MAC9D,IAAA,EAAM,CAAC,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,MAAM,CAAC,CAAA;AAAA,MACvC,UAAA,EAAY,EAAE,QAAA,EAAU,GAAG;AAAA,IAC7B,CAAA;AAAA,IACA,SAAA,EAAW;AAAA,MACT,IAAA,EAAM,MAAA;AAAA,MACN,IAAA,EAAM,WAAA;AAAA,MACN,KAAA,EAAO,WAAA;AAAA,MACP,IAAA,EAAM,EAAE,QAAA,EAAU,QAAA,EAAU,MAAA,EAAQ,cAAc,CAAA;AAAA,MAClD,OAAA,EAAS,CAAC,aAAA,EAAe,OAAA,EAAS,KAAA,EAAO,QAAA,EAAU,YAAY,CAAA;AAAA,MAC/D,IAAA,EAAM,CAAC,EAAE,KAAA,EAAO,aAAA,EAAe,KAAA,EAAO,MAAM,CAAA,EAAG,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,MAAM,CAAC,CAAA;AAAA,MAC/E,QAAA,EAAU,EAAE,MAAA,EAAQ,CAAC,EAAE,KAAA,EAAO,aAAA,EAAe,KAAA,EAAO,KAAA,EAAO,SAAA,EAAW,MAAM,CAAC,EAAE,CAAA;AAAA,MAC/E,UAAA,EAAY,EAAE,QAAA,EAAU,IAAI;AAAA,IAC9B,CAAA;AAAA,IACA,YAAA,EAAc;AAAA,MACZ,IAAA,EAAM,MAAA;AAAA,MACN,IAAA,EAAM,cAAA;AAAA,MACN,KAAA,EAAO,KAAA;AAAA,MACP,IAAA,EAAM,EAAE,QAAA,EAAU,QAAA,EAAU,MAAA,EAAQ,cAAc,CAAA;AAAA,MAClD,OAAA,EAAS,CAAC,OAAA,EAAS,aAAA,EAAe,KAAA,EAAO,QAAA,EAAU,QAAA,EAAU,YAAY,CAAA;AAAA,MACzE,IAAA,EAAM,CAAC,EAAE,KAAA,EAAO,OAAA,EAAS,KAAA,EAAO,MAAM,CAAC,CAAA;AAAA,MACvC,UAAA,EAAY,EAAE,QAAA,EAAU,GAAG;AAAA,IAC7B;AAAA,EACF,CAAA;AAAA,EAEA,MAAA,EAAQ;AAAA,IACN,EAAA,EAAI,WAAA,CAAM,IAAA,CAAK,EAAE,KAAA,EAAO,YAAA,EAAc,QAAA,EAAU,IAAA,EAAM,QAAA,EAAU,IAAA,EAAM,KAAA,EAAO,SAAS,CAAC,CAAA;AAAA,IAEvF,IAAA,EAAM,WAAA,CAAM,IAAA,CAAK;AAAA,MACf,KAAA,EAAO,MAAA;AAAA,MACP,QAAA,EAAU,IAAA;AAAA,MACV,SAAA,EAAW,GAAA;AAAA,MACX,WAAA,EAAa,4DAAA;AAAA,MACb,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,KAAA,EAAO,WAAA,CAAM,IAAA,CAAK;AAAA,MAChB,KAAA,EAAO,eAAA;AAAA,MACP,QAAA,EAAU,KAAA;AAAA,MACV,SAAA,EAAW,GAAA;AAAA,MACX,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,WAAA,EAAa,WAAA,CAAM,IAAA,CAAK;AAAA,MACtB,KAAA,EAAO,QAAA;AAAA,MACP,QAAA,EAAU,KAAA;AAAA,MACV,SAAA,EAAW,GAAA;AAAA;AAAA;AAAA,MAGX,MAAA,EAAQ,YAAA;AAAA,MACR,WAAA,EAAa,gFAAA;AAAA,MACb,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,QAAA,EAAU,WAAA,CAAM,MAAA;AAAA,MACd,CAAC,QAAA,EAAU,QAAA,EAAU,QAAQ,CAAA;AAAA,MAC7B;AAAA,QACE,KAAA,EAAO,UAAA;AAAA,QACP,QAAA,EAAU,KAAA;AAAA;AAAA;AAAA;AAAA,QAIV,QAAA,EAAU,IAAA;AAAA,QACV,WAAA,EAAa,sCAAA;AAAA,QACb,KAAA,EAAO;AAAA,MACT;AAAA,IACF,CAAA;AAAA,IAEA,GAAA,EAAK,WAAA,CAAM,IAAA,CAAK;AAAA,MACd,KAAA,EAAO,YAAA;AAAA,MACP,QAAA,EAAU,IAAA;AAAA,MACV,SAAA,EAAW,IAAA;AAAA,MACX,WAAA,EAAa,0CAAA;AAAA,MACb,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,MAAA,EAAQ,WAAA,CAAM,MAAA;AAAA,MACZ,CAAC,KAAA,EAAO,MAAA,EAAQ,KAAA,EAAO,OAAA,EAAS,QAAQ,CAAA;AAAA,MACxC;AAAA,QACE,KAAA,EAAO,aAAA;AAAA,QACP,QAAA,EAAU,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA,QAKV,YAAA,EAAc,MAAA;AAAA,QACd,WAAA,EAAa,2CAAA;AAAA,QACb,KAAA,EAAO;AAAA,MACT;AAAA,IACF,CAAA;AAAA,IAEA,WAAA,EAAa,WAAA,CAAM,QAAA,CAAS,EAAE,KAAA,EAAO,aAAA,EAAe,QAAA,EAAU,KAAA,EAAO,KAAA,EAAO,aAAa,CAAC,CAAA;AAAA,IAE1F,MAAA,EAAQ,WAAA,CAAM,OAAA,CAAQ;AAAA,MACpB,KAAA,EAAO,QAAA;AAAA,MACP,QAAA,EAAU,IAAA;AAAA,MACV,YAAA,EAAc,IAAA;AAAA,MACd,WAAA,EAAa,iDAAA;AAAA,MACb,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,eAAA,EAAiB,WAAA,CAAM,QAAA,CAAS;AAAA,MAC9B,KAAA,EAAO,YAAA;AAAA,MACP,QAAA,EAAU,IAAA;AAAA,MACV,WAAA,EAAa,kHAAA;AAAA,MACb,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,UAAA,EAAY,WAAA,CAAM,QAAA,CAAS;AAAA,MACzB,KAAA,EAAO,YAAA;AAAA,MACP,QAAA,EAAU,IAAA;AAAA,MACV,YAAA,EAAc,OAAA;AAAA,MACd,QAAA,EAAU,IAAA;AAAA,MACV,KAAA,EAAO;AAAA,IACT,CAAC,CAAA;AAAA,IAED,UAAA,EAAY,WAAA,CAAM,QAAA,CAAS,EAAE,KAAA,EAAO,YAAA,EAAc,QAAA,EAAU,KAAA,EAAO,KAAA,EAAO,SAAS,CAAC;AAAA,EACtF,CAAA;AAAA,EAEA,OAAA,EAAS;AAAA,IACP,EAAE,MAAA,EAAQ,CAAC,MAAM,CAAA,EAAG,MAAA,EAAQ,KAAK,CAAA;AAAA,IACjC,EAAE,MAAA,EAAQ,CAAC,aAAa,EAAE,CAAA;AAAA,IAC1B,EAAE,MAAA,EAAQ,CAAC,QAAA,EAAU,aAAa,EAAE;AAAA,EACtC;AACF,CAAC,CAAA;AD1CD;AACA;AACE;AACF,gCAAC","file":"/home/runner/work/framework/framework/packages/plugins/plugin-webhooks/dist/chunk-PTMJ5BLL.cjs","sourcesContent":[null,"// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.\n\nimport { ObjectSchema, Field } from '@objectstack/spec/data';\n\n/**\n * sys_webhook — Outbound HTTP integration configuration (runtime).\n *\n * Persists a single {@link Webhook} envelope per row so administrators\n * can author, enable/disable, and edit webhook subscriptions from the\n * Studio UI without code changes. The canonical Zod schema for the\n * `definition_json` envelope lives at `@objectstack/spec/automation/webhook`.\n *\n * One row per `name`. The automation runtime\n * (`@objectstack/service-automation`, built-in `http_request` node) loads\n * active rows on boot + on `sys_webhook:changed` events, registers\n * `afterInsert` / `afterUpdate` / `afterDelete` listeners for the\n * targeted object, and dispatches outbound HTTP calls when matching\n * record events fire.\n *\n * Ownership (ADR-0029 K2.a): this object is **owned by\n * `@objectstack/plugin-webhooks`** — the plugin that consumes these rows —\n * alongside its sibling `sys_webhook_delivery`. It used to live in the\n * `@objectstack/platform-objects` monolith and be imported here; the\n * definition now lives with its owner so the plugin ships both data and\n * behavior as one unit.\n *\n * Platform-wide on purpose: every project (standalone, single-tenant,\n * cloud) can integrate with external systems (Slack, Stripe, internal\n * services) the same way.\n *\n * @namespace sys\n */\nexport const SysWebhook = ObjectSchema.create({\n  name: 'sys_webhook',\n  label: 'Webhook',\n  pluralLabel: 'Webhooks',\n  icon: 'webhook',\n  isSystem: true,\n  managedBy: 'config',\n  // Authoring a webhook from the UI requires a structured form for the\n  // headers / auth / retry / payload blocks — the generic JSON textarea\n  // is acceptable as a v1 until a dedicated builder lands. Re-enable\n  // create/edit/delete so admins can at least toggle `active` and edit\n  // simple URL/method fields without round-tripping through code.\n  userActions: { create: true, edit: true, delete: true, import: false },\n  description: 'Outbound HTTP webhook subscription. Authored via defineWebhook() in code or the Studio editor; executed by the HTTP connector plugin.',\n  displayNameField: 'name',\n  nameField: 'name', // [ADR-0079] canonical primary-title pointer (mirrors deprecated displayNameField)\n  titleFormat: '{label}',\n  highlightFields: ['name', 'object_name', 'url', 'active', 'updated_at'],\n\n  listViews: {\n    active: {\n      type: 'grid',\n      name: 'active',\n      label: 'Active',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['label', 'object_name', 'url', 'method', 'active', 'updated_at'],\n      filter: [{ field: 'active', operator: 'equals', value: true }],\n      sort: [{ field: 'label', order: 'asc' }],\n      pagination: { pageSize: 50 },\n    },\n    inactive: {\n      type: 'grid',\n      name: 'inactive',\n      label: 'Inactive',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['label', 'object_name', 'url', 'method', 'active', 'updated_at'],\n      filter: [{ field: 'active', operator: 'equals', value: false }],\n      sort: [{ field: 'label', order: 'asc' }],\n      pagination: { pageSize: 50 },\n    },\n    by_object: {\n      type: 'grid',\n      name: 'by_object',\n      label: 'By Object',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['object_name', 'label', 'url', 'active', 'updated_at'],\n      sort: [{ field: 'object_name', order: 'asc' }, { field: 'label', order: 'asc' }],\n      grouping: { fields: [{ field: 'object_name', order: 'asc', collapsed: false }] },\n      pagination: { pageSize: 100 },\n    },\n    all_webhooks: {\n      type: 'grid',\n      name: 'all_webhooks',\n      label: 'All',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['label', 'object_name', 'url', 'method', 'active', 'updated_at'],\n      sort: [{ field: 'label', order: 'asc' }],\n      pagination: { pageSize: 50 },\n    },\n  },\n\n  fields: {\n    id: Field.text({ label: 'Webhook ID', required: true, readonly: true, group: 'System' }),\n\n    name: Field.text({\n      label: 'Name',\n      required: true,\n      maxLength: 100,\n      description: 'Unique snake_case name — referenced in logs and audit',\n      group: 'Definition',\n    }),\n\n    label: Field.text({\n      label: 'Display Label',\n      required: false,\n      maxLength: 200,\n      group: 'Definition',\n    }),\n\n    object_name: Field.text({\n      label: 'Object',\n      required: false,\n      maxLength: 100,\n      // Object picker (same widget as sys_sharing_rule) instead of a free-text\n      // machine name. Falls back to a text input when the widget is unavailable.\n      widget: 'object-ref',\n      description: 'Short object name whose record events (create/update/delete) fire this webhook',\n      group: 'Definition',\n    }),\n\n    triggers: Field.select(\n      ['create', 'update', 'delete'],\n      {\n        label: 'Triggers',\n        required: false,\n        // Multi-select instead of a hand-typed comma-separated string. Stored as\n        // an array; the auto-enqueuer parser also tolerates the legacy\n        // comma-separated / JSON-string forms so existing rows keep working.\n        multiple: true,\n        description: 'Record events that fire this webhook',\n        group: 'Definition',\n      },\n    ),\n\n    url: Field.text({\n      label: 'Target URL',\n      required: true,\n      maxLength: 2048,\n      description: 'External endpoint that receives the POST',\n      group: 'Definition',\n    }),\n\n    method: Field.select(\n      ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],\n      {\n        label: 'HTTP Method',\n        required: true,\n        // Select instead of free text. Option values are lowercased by the\n        // Field.select helper (get/post/…); the auto-enqueuer upper-cases the\n        // resolved method before delivery, so existing 'POST' rows and the\n        // lowercase option values both normalise correctly.\n        defaultValue: 'post',\n        description: 'HTTP method used for the callback request',\n        group: 'Definition',\n      },\n    ),\n\n    description: Field.textarea({ label: 'Description', required: false, group: 'Definition' }),\n\n    active: Field.boolean({\n      label: 'Active',\n      required: true,\n      defaultValue: true,\n      description: 'Inactive webhooks are skipped by the dispatcher',\n      group: 'Definition',\n    }),\n\n    definition_json: Field.textarea({\n      label: 'Definition',\n      required: true,\n      description: 'Serialised Webhook JSON (see @objectstack/spec/automation/webhook) — full headers/auth/retry/payload config',\n      group: 'Definition',\n    }),\n\n    created_at: Field.datetime({\n      label: 'Created At',\n      required: true,\n      defaultValue: 'NOW()',\n      readonly: true,\n      group: 'System',\n    }),\n\n    updated_at: Field.datetime({ label: 'Updated At', required: false, group: 'System' }),\n  },\n\n  indexes: [\n    { fields: ['name'], unique: true },\n    { fields: ['object_name'] },\n    { fields: ['active', 'object_name'] },\n  ],\n});\n"]}

package/dist/chunk-RBCYKJVL.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../src/sys-webhook.object.ts"],"sourcesContent":["// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.\n\nimport { ObjectSchema, Field } from '@objectstack/spec/data';\n\n/**\n * sys_webhook — Outbound HTTP integration configuration (runtime).\n *\n * Persists a single {@link Webhook} envelope per row so administrators\n * can author, enable/disable, and edit webhook subscriptions from the\n * Studio UI without code changes. The canonical Zod schema for the\n * `definition_json` envelope lives at `@objectstack/spec/automation/webhook`.\n *\n * One row per `name`. The automation runtime\n * (`@objectstack/service-automation`, built-in `http_request` node) loads\n * active rows on boot + on `sys_webhook:changed` events, registers\n * `afterInsert` / `afterUpdate` / `afterDelete` listeners for the\n * targeted object, and dispatches outbound HTTP calls when matching\n * record events fire.\n *\n * Ownership (ADR-0029 K2.a): this object is **owned by\n * `@objectstack/plugin-webhooks`** — the plugin that consumes these rows —\n * alongside its sibling `sys_webhook_delivery`. It used to live in the\n * `@objectstack/platform-objects` monolith and be imported here; the\n * definition now lives with its owner so the plugin ships both data and\n * behavior as one unit.\n *\n * Platform-wide on purpose: every project (standalone, single-tenant,\n * cloud) can integrate with external systems (Slack, Stripe, internal\n * services) the same way.\n *\n * @namespace sys\n */\nexport const SysWebhook = ObjectSchema.create({\n  name: 'sys_webhook',\n  label: 'Webhook',\n  pluralLabel: 'Webhooks',\n  icon: 'webhook',\n  isSystem: true,\n  managedBy: 'config',\n  // Authoring a webhook from the UI requires a structured form for the\n  // headers / auth / retry / payload blocks — the generic JSON textarea\n  // is acceptable as a v1 until a dedicated builder lands. Re-enable\n  // create/edit/delete so admins can at least toggle `active` and edit\n  // simple URL/method fields without round-tripping through code.\n  userActions: { create: true, edit: true, delete: true, import: false },\n  description: 'Outbound HTTP webhook subscription. Authored via defineWebhook() in code or the Studio editor; executed by the HTTP connector plugin.',\n  displayNameField: 'name',\n  nameField: 'name', // [ADR-0079] canonical primary-title pointer (mirrors deprecated displayNameField)\n  titleFormat: '{label}',\n  highlightFields: ['name', 'object_name', 'url', 'active', 'updated_at'],\n\n  listViews: {\n    active: {\n      type: 'grid',\n      name: 'active',\n      label: 'Active',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['label', 'object_name', 'url', 'method', 'active', 'updated_at'],\n      filter: [{ field: 'active', operator: 'equals', value: true }],\n      sort: [{ field: 'label', order: 'asc' }],\n      pagination: { pageSize: 50 },\n    },\n    inactive: {\n      type: 'grid',\n      name: 'inactive',\n      label: 'Inactive',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['label', 'object_name', 'url', 'method', 'active', 'updated_at'],\n      filter: [{ field: 'active', operator: 'equals', value: false }],\n      sort: [{ field: 'label', order: 'asc' }],\n      pagination: { pageSize: 50 },\n    },\n    by_object: {\n      type: 'grid',\n      name: 'by_object',\n      label: 'By Object',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['object_name', 'label', 'url', 'active', 'updated_at'],\n      sort: [{ field: 'object_name', order: 'asc' }, { field: 'label', order: 'asc' }],\n      grouping: { fields: [{ field: 'object_name', order: 'asc', collapsed: false }] },\n      pagination: { pageSize: 100 },\n    },\n    all_webhooks: {\n      type: 'grid',\n      name: 'all_webhooks',\n      label: 'All',\n      data: { provider: 'object', object: 'sys_webhook' },\n      columns: ['label', 'object_name', 'url', 'method', 'active', 'updated_at'],\n      sort: [{ field: 'label', order: 'asc' }],\n      pagination: { pageSize: 50 },\n    },\n  },\n\n  fields: {\n    id: Field.text({ label: 'Webhook ID', required: true, readonly: true, group: 'System' }),\n\n    name: Field.text({\n      label: 'Name',\n      required: true,\n      maxLength: 100,\n      description: 'Unique snake_case name — referenced in logs and audit',\n      group: 'Definition',\n    }),\n\n    label: Field.text({\n      label: 'Display Label',\n      required: false,\n      maxLength: 200,\n      group: 'Definition',\n    }),\n\n    object_name: Field.text({\n      label: 'Object',\n      required: false,\n      maxLength: 100,\n      // Object picker (same widget as sys_sharing_rule) instead of a free-text\n      // machine name. Falls back to a text input when the widget is unavailable.\n      widget: 'object-ref',\n      description: 'Short object name whose record events (create/update/delete) fire this webhook',\n      group: 'Definition',\n    }),\n\n    triggers: Field.select(\n      ['create', 'update', 'delete'],\n      {\n        label: 'Triggers',\n        required: false,\n        // Multi-select instead of a hand-typed comma-separated string. Stored as\n        // an array; the auto-enqueuer parser also tolerates the legacy\n        // comma-separated / JSON-string forms so existing rows keep working.\n        multiple: true,\n        description: 'Record events that fire this webhook',\n        group: 'Definition',\n      },\n    ),\n\n    url: Field.text({\n      label: 'Target URL',\n      required: true,\n      maxLength: 2048,\n      description: 'External endpoint that receives the POST',\n      group: 'Definition',\n    }),\n\n    method: Field.select(\n      ['GET', 'POST', 'PUT', 'PATCH', 'DELETE'],\n      {\n        label: 'HTTP Method',\n        required: true,\n        // Select instead of free text. Option values are lowercased by the\n        // Field.select helper (get/post/…); the auto-enqueuer upper-cases the\n        // resolved method before delivery, so existing 'POST' rows and the\n        // lowercase option values both normalise correctly.\n        defaultValue: 'post',\n        description: 'HTTP method used for the callback request',\n        group: 'Definition',\n      },\n    ),\n\n    description: Field.textarea({ label: 'Description', required: false, group: 'Definition' }),\n\n    active: Field.boolean({\n      label: 'Active',\n      required: true,\n      defaultValue: true,\n      description: 'Inactive webhooks are skipped by the dispatcher',\n      group: 'Definition',\n    }),\n\n    definition_json: Field.textarea({\n      label: 'Definition',\n      required: true,\n      description: 'Serialised Webhook JSON (see @objectstack/spec/automation/webhook) — full headers/auth/retry/payload config',\n      group: 'Definition',\n    }),\n\n    created_at: Field.datetime({\n      label: 'Created At',\n      required: true,\n      defaultValue: 'NOW()',\n      readonly: true,\n      group: 'System',\n    }),\n\n    updated_at: Field.datetime({ label: 'Updated At', required: false, group: 'System' }),\n  },\n\n  indexes: [\n    { fields: ['name'], unique: true },\n    { fields: ['object_name'] },\n    { fields: ['active', 'object_name'] },\n  ],\n});\n"],"mappings":";AAEA,SAAS,cAAc,aAAa;AA8B7B,IAAM,aAAa,aAAa,OAAO;AAAA,EAC5C,MAAM;AAAA,EACN,OAAO;AAAA,EACP,aAAa;AAAA,EACb,MAAM;AAAA,EACN,UAAU;AAAA,EACV,WAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMX,aAAa,EAAE,QAAQ,MAAM,MAAM,MAAM,QAAQ,MAAM,QAAQ,MAAM;AAAA,EACrE,aAAa;AAAA,EACb,kBAAkB;AAAA,EAClB,WAAW;AAAA;AAAA,EACX,aAAa;AAAA,EACb,iBAAiB,CAAC,QAAQ,eAAe,OAAO,UAAU,YAAY;AAAA,EAEtE,WAAW;AAAA,IACT,QAAQ;AAAA,MACN,MAAM;AAAA,MACN,MAAM;AAAA,MACN,OAAO;AAAA,MACP,MAAM,EAAE,UAAU,UAAU,QAAQ,cAAc;AAAA,MAClD,SAAS,CAAC,SAAS,eAAe,OAAO,UAAU,UAAU,YAAY;AAAA,MACzE,QAAQ,CAAC,EAAE,OAAO,UAAU,UAAU,UAAU,OAAO,KAAK,CAAC;AAAA,MAC7D,MAAM,CAAC,EAAE,OAAO,SAAS,OAAO,MAAM,CAAC;AAAA,MACvC,YAAY,EAAE,UAAU,GAAG;AAAA,IAC7B;AAAA,IACA,UAAU;AAAA,MACR,MAAM;AAAA,MACN,MAAM;AAAA,MACN,OAAO;AAAA,MACP,MAAM,EAAE,UAAU,UAAU,QAAQ,cAAc;AAAA,MAClD,SAAS,CAAC,SAAS,eAAe,OAAO,UAAU,UAAU,YAAY;AAAA,MACzE,QAAQ,CAAC,EAAE,OAAO,UAAU,UAAU,UAAU,OAAO,MAAM,CAAC;AAAA,MAC9D,MAAM,CAAC,EAAE,OAAO,SAAS,OAAO,MAAM,CAAC;AAAA,MACvC,YAAY,EAAE,UAAU,GAAG;AAAA,IAC7B;AAAA,IACA,WAAW;AAAA,MACT,MAAM;AAAA,MACN,MAAM;AAAA,MACN,OAAO;AAAA,MACP,MAAM,EAAE,UAAU,UAAU,QAAQ,cAAc;AAAA,MAClD,SAAS,CAAC,eAAe,SAAS,OAAO,UAAU,YAAY;AAAA,MAC/D,MAAM,CAAC,EAAE,OAAO,eAAe,OAAO,MAAM,GAAG,EAAE,OAAO,SAAS,OAAO,MAAM,CAAC;AAAA,MAC/E,UAAU,EAAE,QAAQ,CAAC,EAAE,OAAO,eAAe,OAAO,OAAO,WAAW,MAAM,CAAC,EAAE;AAAA,MAC/E,YAAY,EAAE,UAAU,IAAI;AAAA,IAC9B;AAAA,IACA,cAAc;AAAA,MACZ,MAAM;AAAA,MACN,MAAM;AAAA,MACN,OAAO;AAAA,MACP,MAAM,EAAE,UAAU,UAAU,QAAQ,cAAc;AAAA,MAClD,SAAS,CAAC,SAAS,eAAe,OAAO,UAAU,UAAU,YAAY;AAAA,MACzE,MAAM,CAAC,EAAE,OAAO,SAAS,OAAO,MAAM,CAAC;AAAA,MACvC,YAAY,EAAE,UAAU,GAAG;AAAA,IAC7B;AAAA,EACF;AAAA,EAEA,QAAQ;AAAA,IACN,IAAI,MAAM,KAAK,EAAE,OAAO,cAAc,UAAU,MAAM,UAAU,MAAM,OAAO,SAAS,CAAC;AAAA,IAEvF,MAAM,MAAM,KAAK;AAAA,MACf,OAAO;AAAA,MACP,UAAU;AAAA,MACV,WAAW;AAAA,MACX,aAAa;AAAA,MACb,OAAO;AAAA,IACT,CAAC;AAAA,IAED,OAAO,MAAM,KAAK;AAAA,MAChB,OAAO;AAAA,MACP,UAAU;AAAA,MACV,WAAW;AAAA,MACX,OAAO;AAAA,IACT,CAAC;AAAA,IAED,aAAa,MAAM,KAAK;AAAA,MACtB,OAAO;AAAA,MACP,UAAU;AAAA,MACV,WAAW;AAAA;AAAA;AAAA,MAGX,QAAQ;AAAA,MACR,aAAa;AAAA,MACb,OAAO;AAAA,IACT,CAAC;AAAA,IAED,UAAU,MAAM;AAAA,MACd,CAAC,UAAU,UAAU,QAAQ;AAAA,MAC7B;AAAA,QACE,OAAO;AAAA,QACP,UAAU;AAAA;AAAA;AAAA;AAAA,QAIV,UAAU;AAAA,QACV,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,IACF;AAAA,IAEA,KAAK,MAAM,KAAK;AAAA,MACd,OAAO;AAAA,MACP,UAAU;AAAA,MACV,WAAW;AAAA,MACX,aAAa;AAAA,MACb,OAAO;AAAA,IACT,CAAC;AAAA,IAED,QAAQ,MAAM;AAAA,MACZ,CAAC,OAAO,QAAQ,OAAO,SAAS,QAAQ;AAAA,MACxC;AAAA,QACE,OAAO;AAAA,QACP,UAAU;AAAA;AAAA;AAAA;AAAA;AAAA,QAKV,cAAc;AAAA,QACd,aAAa;AAAA,QACb,OAAO;AAAA,MACT;AAAA,IACF;AAAA,IAEA,aAAa,MAAM,SAAS,EAAE,OAAO,eAAe,UAAU,OAAO,OAAO,aAAa,CAAC;AAAA,IAE1F,QAAQ,MAAM,QAAQ;AAAA,MACpB,OAAO;AAAA,MACP,UAAU;AAAA,MACV,cAAc;AAAA,MACd,aAAa;AAAA,MACb,OAAO;AAAA,IACT,CAAC;AAAA,IAED,iBAAiB,MAAM,SAAS;AAAA,MAC9B,OAAO;AAAA,MACP,UAAU;AAAA,MACV,aAAa;AAAA,MACb,OAAO;AAAA,IACT,CAAC;AAAA,IAED,YAAY,MAAM,SAAS;AAAA,MACzB,OAAO;AAAA,MACP,UAAU;AAAA,MACV,cAAc;AAAA,MACd,UAAU;AAAA,MACV,OAAO;AAAA,IACT,CAAC;AAAA,IAED,YAAY,MAAM,SAAS,EAAE,OAAO,cAAc,UAAU,OAAO,OAAO,SAAS,CAAC;AAAA,EACtF;AAAA,EAEA,SAAS;AAAA,IACP,EAAE,QAAQ,CAAC,MAAM,GAAG,QAAQ,KAAK;AAAA,IACjC,EAAE,QAAQ,CAAC,aAAa,EAAE;AAAA,IAC1B,EAAE,QAAQ,CAAC,UAAU,aAAa,EAAE;AAAA,EACtC;AACF,CAAC;","names":[]}