@objectstack/plugin-webhooks 7.2.1 → 7.4.0

package/src/translations/es-ES.objects.generated.ts

@@ -0,0 +1,187 @@
+// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+
+/**
+ * Auto-generated by 'os i18n extract' for locale 'es-ES'.
+ * Edit translations in place; re-run extract (with --merge) to fill new gaps.
+ * Do not hand-edit the structure — only the leaf string values.
+ */
+
+import type { TranslationData } from '@objectstack/spec/system';
+
+export const esESObjects: NonNullable<TranslationData['objects']> = {
+  sys_webhook: {
+    label: "Webhook",
+    pluralLabel: "Webhooks",
+    description: "Suscripción saliente de Webhook HTTP. Se crea mediante defineWebhook() en código o con el editor de Studio; la ejecuta el plugin del conector HTTP.",
+    fields: {
+      id: {
+        label: "ID de webhook"
+      },
+      name: {
+        label: "Nombre",
+        help: "Nombre snake_case único; se usa en los registros y en la auditoría."
+      },
+      label: {
+        label: "Nombre visible"
+      },
+      object_name: {
+        label: "Objeto",
+        help: "Nombre corto del objeto cuyos eventos activan este Webhook (vacío = activación manual / API)."
+      },
+      triggers: {
+        label: "Desencadenantes",
+        help: "Lista de eventos separada por comas: create,update,delete,undelete,api."
+      },
+      url: {
+        label: "URL de destino",
+        help: "Endpoint externo que recibe el POST."
+      },
+      method: {
+        label: "Método HTTP",
+        help: "GET / POST / PUT / PATCH / DELETE"
+      },
+      description: {
+        label: "Descripción"
+      },
+      active: {
+        label: "Activo",
+        help: "Los Webhooks inactivos se omiten en el despachador."
+      },
+      definition_json: {
+        label: "Definición",
+        help: "JSON serializado de Webhook (consulte @objectstack/spec/automation/webhook): configuración completa de cabeceras/auth/reintentos/payload."
+      },
+      created_at: {
+        label: "Creado el"
+      },
+      updated_at: {
+        label: "Actualizado el"
+      }
+    },
+    _views: {
+      active: {
+        label: "Activo"
+      },
+      inactive: {
+        label: "Inactivo"
+      },
+      by_object: {
+        label: "Por objeto"
+      },
+      all_webhooks: {
+        label: "Todos"
+      }
+    }
+  },
+  sys_webhook_delivery: {
+    label: "Webhook Delivery",
+    pluralLabel: "Webhook Deliveries",
+    description: "Durable outbox row for one webhook attempt. Managed by @objectstack/plugin-webhooks; do not write directly.",
+    fields: {
+      id: {
+        label: "Delivery ID",
+        help: "UUID — also doubles as the receiver-side idempotency key"
+      },
+      webhook_id: {
+        label: "Webhook ID",
+        help: "FK to sys_webhook.id (loosely coupled — denormalised URL/secret on row)"
+      },
+      event_id: {
+        label: "Event ID",
+        help: "Source event id; UNIQUE(event_id, webhook_id) for dedup"
+      },
+      event_type: {
+        label: "Event Type",
+        help: "e.g. data.record.created"
+      },
+      url: {
+        label: "Target URL",
+        help: "Snapshotted at enqueue so config edits do not rewrite live rows"
+      },
+      method: {
+        label: "Method"
+      },
+      headers_json: {
+        label: "Headers JSON"
+      },
+      secret: {
+        label: "HMAC Secret"
+      },
+      timeout_ms: {
+        label: "Timeout (ms)"
+      },
+      payload_json: {
+        label: "Payload JSON"
+      },
+      partition_key: {
+        label: "Partition",
+        help: "hash(webhook_id) mod partitionCount — precomputed for cheap WHERE"
+      },
+      status: {
+        label: "Status",
+        help: "pending | in_flight | success | failed | dead"
+      },
+      attempts: {
+        label: "Attempts",
+        help: "Number of POST attempts made so far"
+      },
+      claimed_by: {
+        label: "Claimed By"
+      },
+      claimed_at: {
+        label: "Claimed At (ms)"
+      },
+      next_retry_at: {
+        label: "Next Retry At (ms)"
+      },
+      last_attempted_at: {
+        label: "Last Attempted At (ms)"
+      },
+      response_code: {
+        label: "HTTP Status"
+      },
+      response_body: {
+        label: "Response Body (capped)"
+      },
+      error: {
+        label: "Error"
+      },
+      created_at: {
+        label: "Created At (ms)"
+      },
+      updated_at: {
+        label: "Updated At (ms)"
+      }
+    },
+    _views: {
+      recent: {
+        label: "Recent"
+      },
+      failures: {
+        label: "Failures"
+      },
+      in_flight: {
+        label: "In Flight"
+      },
+      pending: {
+        label: "Pending"
+      },
+      by_status: {
+        label: "By Status"
+      },
+      by_webhook: {
+        label: "By Webhook"
+      },
+      all_deliveries: {
+        label: "All"
+      }
+    },
+    _actions: {
+      redeliver: {
+        label: "Redeliver",
+        confirmText: "Replay this delivery? The receiver will get the original payload again — they must be idempotent on the X-Objectstack-Delivery header.",
+        successMessage: "Queued for redelivery"
+      }
+    }
+  }
+};

package/src/translations/index.ts

@@ -0,0 +1,23 @@
+// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.
+
+/**
+ * WebhooksTranslations — i18n bundle owned by this plugin (ADR-0029 D8).
+ *
+ * Object label/field/view/action translations for the sys_* objects this
+ * plugin owns. Loaded at runtime via the plugin's `kernel:ready` hook
+ * (`i18n.loadTranslations`). Regenerate with `os i18n extract` against
+ * `scripts/i18n-extract.config.ts`.
+ */
+
+import type { TranslationBundle } from '@objectstack/spec/system';
+import { enObjects } from './en.objects.generated.js';
+import { zhCNObjects } from './zh-CN.objects.generated.js';
+import { jaJPObjects } from './ja-JP.objects.generated.js';
+import { esESObjects } from './es-ES.objects.generated.js';
+
+export const WebhooksTranslations: TranslationBundle = {
+  en: { objects: enObjects },
+  'zh-CN': { objects: zhCNObjects },
+  'ja-JP': { objects: jaJPObjects },
+  'es-ES': { objects: esESObjects },
+};

package/src/translations/ja-JP.objects.generated.ts

@@ -0,0 +1,187 @@
+// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+
+/**
+ * Auto-generated by 'os i18n extract' for locale 'ja-JP'.
+ * Edit translations in place; re-run extract (with --merge) to fill new gaps.
+ * Do not hand-edit the structure — only the leaf string values.
+ */
+
+import type { TranslationData } from '@objectstack/spec/system';
+
+export const jaJPObjects: NonNullable<TranslationData['objects']> = {
+  sys_webhook: {
+    label: "Webhook",
+    pluralLabel: "Webhook",
+    description: "送信 HTTP Webhook サブスクリプション。defineWebhook() またはスタジオエディタで作成し、HTTP コネクタプラグインが実行します。",
+    fields: {
+      id: {
+        label: "Webhook ID"
+      },
+      name: {
+        label: "名前",
+        help: "一意の snake_case 名 — ログおよび監査で参照"
+      },
+      label: {
+        label: "表示名"
+      },
+      object_name: {
+        label: "オブジェクト",
+        help: "このウェブフックを発火するイベントのオブジェクト短縮名（空白 = 手動 / API トリガー）"
+      },
+      triggers: {
+        label: "トリガー",
+        help: "カンマ区切りのイベントリスト: create,update,delete,undelete,api"
+      },
+      url: {
+        label: "ターゲット URL",
+        help: "POST を受信する外部エンドポイント"
+      },
+      method: {
+        label: "HTTP メソッド",
+        help: "GET / POST / PUT / PATCH / DELETE"
+      },
+      description: {
+        label: "説明"
+      },
+      active: {
+        label: "有効",
+        help: "無効にするとディスパッチャにスキップされます"
+      },
+      definition_json: {
+        label: "定義",
+        help: "シリアライズされた Webhook JSON（@objectstack/spec/automation/webhook 参照）— ヘッダー/認証/リトライ/ペイロード設定を含む"
+      },
+      created_at: {
+        label: "作成日時"
+      },
+      updated_at: {
+        label: "更新日時"
+      }
+    },
+    _views: {
+      active: {
+        label: "有効"
+      },
+      inactive: {
+        label: "無効"
+      },
+      by_object: {
+        label: "オブジェクト別"
+      },
+      all_webhooks: {
+        label: "すべて"
+      }
+    }
+  },
+  sys_webhook_delivery: {
+    label: "Webhook Delivery",
+    pluralLabel: "Webhook Deliveries",
+    description: "Durable outbox row for one webhook attempt. Managed by @objectstack/plugin-webhooks; do not write directly.",
+    fields: {
+      id: {
+        label: "Delivery ID",
+        help: "UUID — also doubles as the receiver-side idempotency key"
+      },
+      webhook_id: {
+        label: "Webhook ID",
+        help: "FK to sys_webhook.id (loosely coupled — denormalised URL/secret on row)"
+      },
+      event_id: {
+        label: "Event ID",
+        help: "Source event id; UNIQUE(event_id, webhook_id) for dedup"
+      },
+      event_type: {
+        label: "Event Type",
+        help: "e.g. data.record.created"
+      },
+      url: {
+        label: "Target URL",
+        help: "Snapshotted at enqueue so config edits do not rewrite live rows"
+      },
+      method: {
+        label: "Method"
+      },
+      headers_json: {
+        label: "Headers JSON"
+      },
+      secret: {
+        label: "HMAC Secret"
+      },
+      timeout_ms: {
+        label: "Timeout (ms)"
+      },
+      payload_json: {
+        label: "Payload JSON"
+      },
+      partition_key: {
+        label: "Partition",
+        help: "hash(webhook_id) mod partitionCount — precomputed for cheap WHERE"
+      },
+      status: {
+        label: "Status",
+        help: "pending | in_flight | success | failed | dead"
+      },
+      attempts: {
+        label: "Attempts",
+        help: "Number of POST attempts made so far"
+      },
+      claimed_by: {
+        label: "Claimed By"
+      },
+      claimed_at: {
+        label: "Claimed At (ms)"
+      },
+      next_retry_at: {
+        label: "Next Retry At (ms)"
+      },
+      last_attempted_at: {
+        label: "Last Attempted At (ms)"
+      },
+      response_code: {
+        label: "HTTP Status"
+      },
+      response_body: {
+        label: "Response Body (capped)"
+      },
+      error: {
+        label: "Error"
+      },
+      created_at: {
+        label: "Created At (ms)"
+      },
+      updated_at: {
+        label: "Updated At (ms)"
+      }
+    },
+    _views: {
+      recent: {
+        label: "Recent"
+      },
+      failures: {
+        label: "Failures"
+      },
+      in_flight: {
+        label: "In Flight"
+      },
+      pending: {
+        label: "Pending"
+      },
+      by_status: {
+        label: "By Status"
+      },
+      by_webhook: {
+        label: "By Webhook"
+      },
+      all_deliveries: {
+        label: "All"
+      }
+    },
+    _actions: {
+      redeliver: {
+        label: "Redeliver",
+        confirmText: "Replay this delivery? The receiver will get the original payload again — they must be idempotent on the X-Objectstack-Delivery header.",
+        successMessage: "Queued for redelivery"
+      }
+    }
+  }
+};

package/src/translations/zh-CN.objects.generated.ts

@@ -0,0 +1,187 @@
+// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+
+/**
+ * Auto-generated by 'os i18n extract' for locale 'zh-CN'.
+ * Edit translations in place; re-run extract (with --merge) to fill new gaps.
+ * Do not hand-edit the structure — only the leaf string values.
+ */
+
+import type { TranslationData } from '@objectstack/spec/system';
+
+export const zhCNObjects: NonNullable<TranslationData['objects']> = {
+  sys_webhook: {
+    label: "Webhook",
+    pluralLabel: "Webhook",
+    description: "外发 HTTP Webhook 订阅。可在代码中通过 defineWebhook() 编写，或在 Studio 编辑器中维护；由 HTTP 连接器插件执行。",
+    fields: {
+      id: {
+        label: "Webhook ID"
+      },
+      name: {
+        label: "名称",
+        help: "唯一的 snake_case 名称——用于日志和审计引用"
+      },
+      label: {
+        label: "显示标签"
+      },
+      object_name: {
+        label: "对象",
+        help: "触发该 Webhook 的短对象名（留空 = 手动 / API 触发）"
+      },
+      triggers: {
+        label: "触发器",
+        help: "以逗号分隔的事件列表：create,update,delete,undelete,api"
+      },
+      url: {
+        label: "目标 URL",
+        help: "接收 POST 请求的外部端点"
+      },
+      method: {
+        label: "HTTP 方法",
+        help: "GET / POST / PUT / PATCH / DELETE"
+      },
+      description: {
+        label: "描述"
+      },
+      active: {
+        label: "启用",
+        help: "停用的 Webhook 会被调度器跳过"
+      },
+      definition_json: {
+        label: "定义",
+        help: "序列化的 Webhook JSON（参见 @objectstack/spec/automation/webhook）——包含完整的 headers/auth/retry/payload 配置"
+      },
+      created_at: {
+        label: "创建时间"
+      },
+      updated_at: {
+        label: "更新时间"
+      }
+    },
+    _views: {
+      active: {
+        label: "启用"
+      },
+      inactive: {
+        label: "停用"
+      },
+      by_object: {
+        label: "按对象"
+      },
+      all_webhooks: {
+        label: "全部"
+      }
+    }
+  },
+  sys_webhook_delivery: {
+    label: "Webhook Delivery",
+    pluralLabel: "Webhook Deliveries",
+    description: "Durable outbox row for one webhook attempt. Managed by @objectstack/plugin-webhooks; do not write directly.",
+    fields: {
+      id: {
+        label: "Delivery ID",
+        help: "UUID — also doubles as the receiver-side idempotency key"
+      },
+      webhook_id: {
+        label: "Webhook ID",
+        help: "FK to sys_webhook.id (loosely coupled — denormalised URL/secret on row)"
+      },
+      event_id: {
+        label: "Event ID",
+        help: "Source event id; UNIQUE(event_id, webhook_id) for dedup"
+      },
+      event_type: {
+        label: "Event Type",
+        help: "e.g. data.record.created"
+      },
+      url: {
+        label: "Target URL",
+        help: "Snapshotted at enqueue so config edits do not rewrite live rows"
+      },
+      method: {
+        label: "Method"
+      },
+      headers_json: {
+        label: "Headers JSON"
+      },
+      secret: {
+        label: "HMAC Secret"
+      },
+      timeout_ms: {
+        label: "Timeout (ms)"
+      },
+      payload_json: {
+        label: "Payload JSON"
+      },
+      partition_key: {
+        label: "Partition",
+        help: "hash(webhook_id) mod partitionCount — precomputed for cheap WHERE"
+      },
+      status: {
+        label: "Status",
+        help: "pending | in_flight | success | failed | dead"
+      },
+      attempts: {
+        label: "Attempts",
+        help: "Number of POST attempts made so far"
+      },
+      claimed_by: {
+        label: "Claimed By"
+      },
+      claimed_at: {
+        label: "Claimed At (ms)"
+      },
+      next_retry_at: {
+        label: "Next Retry At (ms)"
+      },
+      last_attempted_at: {
+        label: "Last Attempted At (ms)"
+      },
+      response_code: {
+        label: "HTTP Status"
+      },
+      response_body: {
+        label: "Response Body (capped)"
+      },
+      error: {
+        label: "Error"
+      },
+      created_at: {
+        label: "Created At (ms)"
+      },
+      updated_at: {
+        label: "Updated At (ms)"
+      }
+    },
+    _views: {
+      recent: {
+        label: "Recent"
+      },
+      failures: {
+        label: "Failures"
+      },
+      in_flight: {
+        label: "In Flight"
+      },
+      pending: {
+        label: "Pending"
+      },
+      by_status: {
+        label: "By Status"
+      },
+      by_webhook: {
+        label: "By Webhook"
+      },
+      all_deliveries: {
+        label: "All"
+      }
+    },
+    _actions: {
+      redeliver: {
+        label: "Redeliver",
+        confirmText: "Replay this delivery? The receiver will get the original payload again — they must be idempotent on the X-Objectstack-Delivery header.",
+        successMessage: "Queued for redelivery"
+      }
+    }
+  }
+};

package/src/webhook-outbox-plugin.ts

@@ -7,7 +7,6 @@ import type {
     IDataEngine,
     IRealtimeService,
 } from '@objectstack/spec/contracts';
-import { SysWebhook } from '@objectstack/platform-objects/integration';
 import { AutoEnqueuer, type AutoEnqueuerOptions } from './auto-enqueuer.js';
 import { WebhookDispatcher, type DispatcherOptions } from './dispatcher.js';
 import { MemoryWebhookOutbox } from './memory-outbox.js';
@@ -17,6 +16,7 @@ import {
     type DeliveryRetentionOptions,
 } from './retention.js';
 import { SqlWebhookOutbox } from './sql-outbox.js';
+import { SysWebhook } from './sys-webhook.object.js';
 import { SysWebhookDelivery } from './sys-webhook-delivery.object.js';
 
 export interface WebhookOutboxPluginOptions
@@ -117,12 +117,12 @@ export class WebhookOutboxPlugin implements Plugin {
             );
         }
 
-        // Register the schemas this plugin owns at runtime. `sys_webhook`
-        // (config) lives in @objectstack/platform-objects but no other
-        // plugin claims it — the webhook plugin is the natural owner
-        // since it's the consumer of those rows. `sys_webhook_delivery`
-        // (telemetry) is plugin-private. Registering them here means a
-        // stack just needs `plugins: [new WebhookOutboxPlugin(...)]`
+        // Register the schemas this plugin owns at runtime (ADR-0029 K2.a).
+        // Both `sys_webhook` (config) and `sys_webhook_delivery` (telemetry)
+        // are now defined and owned here — the webhook plugin ships its data
+        // model and behavior as one unit instead of importing `sys_webhook`
+        // from the @objectstack/platform-objects monolith. Registering them
+        // here means a stack just needs `plugins: [new WebhookOutboxPlugin(...)]`
         // and both objects auto-appear in REST/Studio/Setup nav.
         const manifest = ctx.getService<{ register(m: any): void }>('manifest');
         if (manifest && typeof manifest.register === 'function') {
@@ -136,6 +136,21 @@ export class WebhookOutboxPlugin implements Plugin {
                 description:
                     'Registers sys_webhook (configuration) and sys_webhook_delivery (durable outbox telemetry).',
                 objects: [SysWebhook, SysWebhookDelivery],
+                // ADR-0029 D7 — contribute the Webhooks entries into the
+                // Setup app's `group_integrations` slot. The plugin owns these
+                // objects (K2.a), so it ships their menu too; when the plugin
+                // isn't installed the slot stays empty.
+                navigationContributions: [
+                    {
+                        app: 'setup',
+                        group: 'group_integrations',
+                        priority: 100,
+                        items: [
+                            { id: 'nav_webhooks', type: 'object', label: 'Webhooks', objectName: 'sys_webhook', icon: 'webhook', requiresObject: 'sys_webhook' },
+                            { id: 'nav_webhook_deliveries', type: 'object', label: 'Webhook Deliveries', objectName: 'sys_webhook_delivery', icon: 'send', requiresObject: 'sys_webhook_delivery' },
+                        ],
+                    },
+                ],
             });
         } else {
             ctx.logger.warn?.(
@@ -143,6 +158,22 @@ export class WebhookOutboxPlugin implements Plugin {
             );
         }
 
+        // ADR-0029 D8 — contribute this plugin's object translations to the
+        // i18n service on kernel:ready (the i18n plugin may register later).
+        if (typeof (ctx as any).hook === 'function') {
+            (ctx as any).hook('kernel:ready', async () => {
+                try {
+                    const i18n = ctx.getService<any>('i18n');
+                    if (i18n && typeof i18n.loadTranslations === 'function') {
+                        const { WebhooksTranslations } = await import('./translations/index.js');
+                        for (const [locale, data] of Object.entries(WebhooksTranslations)) {
+                            i18n.loadTranslations(locale, data as Record<string, unknown>);
+                        }
+                    }
+                } catch { /* i18n optional */ }
+            });
+        }
+
         const outbox = this.resolveOutbox(ctx);
         this.outboxInstance = outbox;
         const nodeId =