@checkstack/integration-common 0.4.0 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,115 @@
 # @checkstack/integration-common
 
+## 0.6.0
+
+### Minor Changes
+
+- 41c77f4: feat(automation): one-time migration of webhook subscriptions + remove legacy integration backend
+
+  **BREAKING CHANGES** (platform is in BETA — no major bump):
+
+  - `IntegrationProvider` no longer carries `config` (subscription
+    config) or `deliver`. The interface now models a connection provider
+    only: connection schema + `getConnectionOptions` + `testConnection`.
+  - The legacy subscription / delivery-log / event endpoints
+    (`listSubscriptions`, `createSubscription`, `getDeliveryLogs`,
+    `listEventTypes`, …) are removed from `integrationContract`.
+  - `delivery-coordinator`, `hook-subscriber`, `event-registry`, and the
+    `integrationEventExtensionPoint` are deleted. Plugins that
+    previously called `integrationEvents.registerEvent(...)` now
+    register their hooks as automation triggers via
+    `automationTriggerExtensionPoint.registerTrigger(...)`.
+  - Frontend pages `IntegrationsPage` and `DeliveryLogsPage` are gone;
+    the integration plugin's only remaining UI is connection
+    management. Subscription management lives under `/automation/...`.
+  - `webhook_subscriptions` and `delivery_logs` tables stay in the
+    database for one release as a safety net (no code reads or writes
+    them), and will be dropped in a follow-up migration.
+
+  **New**:
+
+  - `jira.create_issue`, `teams.post_message`, `webex.post_message`,
+    `webhook.send`, `integration-script.run_shell`, and
+    `integration-script.run_script` actions registered against the
+    Automation Platform with matching `*.message`, `*.delivery`,
+    `shell.result`, and `script.result` artifact types. The script
+    plugin exposes **two** actions — `run_shell` runs bash via the
+    shared `ShellScriptRunner` (Monaco `shell` editor), `run_script`
+    runs an ESM module in a Bun subprocess via `EsmScriptRunner`
+    (Monaco `typescript` editor + `defineIntegration` helper) — to
+    preserve the legacy provider split. `jira.create_issue` keeps the
+    dynamic field-mapping dropdown (driven by
+    `JIRA_RESOLVERS.FIELD_OPTIONS`).
+  - One-time data migration runs on boot in
+    `automation-backend.afterPluginsReady`. It reads
+    `webhook_subscriptions` via a new service RPC
+    `IntegrationApi.listLegacySubscriptions`, translates each row into
+    a single-trigger / single-action automation (marked with
+    `managed_by = "migrated-subscription:<id>"`), and is idempotent
+    across restarts.
+  - Failed translations are recorded in a new
+    `automation_migration_failures` table and surfaced via
+    `AutomationApi.listMigrationFailures` /
+    `acknowledgeMigrationFailure` so admins can review and re-create
+    failed entries by hand.
+
+### Patch Changes
+
+- Updated dependencies [6d52276]
+  - @checkstack/common@0.12.0
+  - @checkstack/signal-common@0.2.5
+
+## 0.5.0
+
+### Minor Changes
+
+- f23f3c9: Sweep every paginated `*-common` contract onto the canonical
+  `PaginationInput` / `PaginatedResult` from `@checkstack/common` and
+  remove the now-unused legacy exports.
+
+  **BREAKING CHANGE** - `@checkstack/common` drops the deprecated
+  `PaginationInputSchema`, `paginatedOutput`, and `PaginatedResponse`
+  symbols. Callers must consume `PaginationInput` (input) and
+  `PaginatedResult(itemSchema)` (output) instead. The canonical input is
+  `{ limit (1-100, default 20), offset (>= 0, default 0) }`; the
+  canonical output envelope is
+  `{ items, total, limit, offset }`.
+
+  **BREAKING CHANGE** - `@checkstack/notification-common` migrates
+  `getNotifications` off the legacy `PaginationInputSchema`
+  (`{ limit, offset, unreadOnly }` with output `{ notifications, total }`)
+  onto `ListNotificationsInputSchema =
+PaginationInput.extend({ unreadOnly })` and
+  `PaginatedResult(NotificationSchema)`. The output key changes from
+  `notifications` to `items`, and `limit` / `offset` are now echoed on
+  the response. The `PaginationInput` type alias previously exported
+  from `notification-common` is removed - use `ListNotificationsInput`
+  or the canonical `PaginationInput` from `@checkstack/common`.
+
+  **BREAKING CHANGE** - `@checkstack/integration-common` migrates
+  `listSubscriptions` (inline `{ page, pageSize, ... }` -> output
+  `{ subscriptions, total }`) and `getDeliveryLogs` (via
+  `DeliveryLogQueryInputSchema` `{ subscriptionId?, eventType?, status?,
+page, pageSize }` -> output `{ logs, total }`) onto the canonical
+  `PaginationInput.extend({...})` input and
+  `PaginatedResult(itemSchema)` output. External callers must switch
+  from `{ page, pageSize }` to `{ limit, offset }` and read response
+  items from `data.items` (no more `data.subscriptions` / `data.logs`).
+
+  The matching `*-backend` handlers were updated to consume the new
+  input shape (`offset` arithmetic in lieu of `(page - 1) * pageSize`)
+  and to echo `limit` / `offset` on the response. The `*-frontend` call
+  sites in `NotificationsPage`, `NotificationBell`, `IntegrationsPage`,
+  and `DeliveryLogsPage` were updated to send the new input shape and
+  read `data.items`.
+
+### Patch Changes
+
+- Updated dependencies [f23f3c9]
+- Updated dependencies [f23f3c9]
+  - @checkstack/common@0.11.0
+  - @checkstack/signal-common@0.2.4
+
 ## 0.4.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/integration-common",
-  "version": "0.4.0",
+  "version": "0.6.0",
   "license": "Elastic-2.0",
   "type": "module",
   "exports": {
@@ -10,15 +10,15 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.9.0",
-    "@checkstack/signal-common": "0.2.2",
+    "@checkstack/common": "0.11.0",
+    "@checkstack/signal-common": "0.2.4",
     "@orpc/contract": "^1.13.14",
     "zod": "^4.0.0"
   },
   "devDependencies": {
     "@checkstack/tsconfig": "0.0.7",
     "typescript": "^5.7.2",
-    "@checkstack/scripts": "0.3.1"
+    "@checkstack/scripts": "0.3.3"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/routes.ts

@@ -2,14 +2,14 @@ import { createRoutes } from "@checkstack/common";
 
 /**
  * Route definitions for the integration plugin.
+ *
+ * The legacy subscription list / delivery log routes were removed when
+ * the platform moved to the Automation Platform model. The remaining
+ * surface is the per-provider connection management page.
  */
 export const integrationRoutes = createRoutes("integration", {
-  /** Main integrations management page */
+  /** Main connections landing page */
   list: "/",
-  /** Delivery logs page (all logs) */
-  logs: "/logs",
-  /** Delivery logs filtered by subscription */
-  deliveryLogs: "/logs/:subscriptionId",
   /** Provider connections management */
   connections: "/connections/:providerId",
 });

package/src/rpc-contract.ts

@@ -1,104 +1,36 @@
 import { z } from "zod";
 import { integrationAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
-import { createClientDefinition, proc } from "@checkstack/common";
 import {
-  WebhookSubscriptionSchema,
-  CreateSubscriptionInputSchema,
-  UpdateSubscriptionInputSchema,
-  DeliveryLogSchema,
-  DeliveryLogQueryInputSchema,
+  createClientDefinition,
+  proc,
+} from "@checkstack/common";
+import {
   IntegrationProviderInfoSchema,
-  IntegrationEventInfoSchema,
   TestConnectionResultSchema,
   ProviderConnectionRedactedSchema,
   CreateConnectionInputSchema,
   UpdateConnectionInputSchema,
   GetConnectionOptionsInputSchema,
   ConnectionOptionSchema,
-  EventPayloadSchemaOutputSchema,
 } from "./schemas";
 
-// Integration RPC Contract
+/**
+ * Integration RPC contract — scoped to connection management.
+ *
+ * The legacy subscription + delivery-log + event-listing endpoints
+ * moved to the Automation Platform; existing subscriptions are
+ * auto-migrated on boot (see `@checkstack/automation-backend`'s
+ * migration module). All remaining endpoints relate to the connection
+ * store, which the Automation editor uses to pick a connection for
+ * provider-bound actions.
+ */
 export const integrationContract = {
-  // ==========================================================================
-  // SUBSCRIPTION MANAGEMENT (Admin only)
-  // ==========================================================================
-
-  /** List all webhook subscriptions */
-  listSubscriptions: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(
-      z.object({
-        page: z.number().min(1).default(1),
-        pageSize: z.number().min(1).max(100).default(20),
-        providerId: z.string().optional(),
-        eventType: z.string().optional(),
-        enabled: z.boolean().optional(),
-      })
-    )
-    .output(
-      z.object({
-        subscriptions: z.array(WebhookSubscriptionSchema),
-        total: z.number(),
-      })
-    ),
-
-  /** Get a single subscription by ID */
-  getSubscription: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(z.object({ id: z.string() }))
-    .output(WebhookSubscriptionSchema),
-
-  /** Create a new webhook subscription */
-  createSubscription: proc({
-    operationType: "mutation",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(CreateSubscriptionInputSchema)
-    .output(WebhookSubscriptionSchema),
-
-  /** Update an existing subscription */
-  updateSubscription: proc({
-    operationType: "mutation",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .route({ method: "PATCH" })
-    .input(UpdateSubscriptionInputSchema)
-    .output(WebhookSubscriptionSchema),
-
-  /** Delete a subscription */
-  deleteSubscription: proc({
-    operationType: "mutation",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .route({ method: "DELETE" })
-    .input(z.object({ id: z.string() }))
-    .output(z.object({ success: z.boolean() })),
-
-  /** Toggle subscription enabled state */
-  toggleSubscription: proc({
-    operationType: "mutation",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(z.object({ id: z.string(), enabled: z.boolean() }))
-    .output(z.object({ success: z.boolean() })),
-
   // ==========================================================================
   // PROVIDER DISCOVERY (Admin only)
   // ==========================================================================
 
-  /** List all registered integration providers */
+  /** List all registered integration providers (connection-capable plugins) */
   listProviders: proc({
     operationType: "query",
     userType: "authenticated",
@@ -121,7 +53,6 @@ export const integrationContract = {
 
   // ==========================================================================
   // CONNECTION MANAGEMENT (Admin only)
-  // Generic CRUD for site-wide provider connections
   // ==========================================================================
 
   /** List all connections for a provider */
@@ -190,116 +121,39 @@ export const integrationContract = {
     .output(z.array(ConnectionOptionSchema)),
 
   // ==========================================================================
-  // EVENT DISCOVERY (Admin only)
+  // ONE-TIME MIGRATION SUPPORT (service-to-service)
+  //
+  // Exposed so `@checkstack/automation-backend` can read the legacy
+  // `webhook_subscriptions` rows during boot and translate them into
+  // automations. Plugins are sandboxed to their own schema, so this is
+  // the only way to reach the legacy table from another plugin.
+  // Once the legacy table is dropped in a follow-up release these
+  // endpoints will be removed.
   // ==========================================================================
 
-  /** List all registered integration events */
-  listEventTypes: proc({
+  listLegacySubscriptions: proc({
     operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  }).output(z.array(IntegrationEventInfoSchema)),
-
-  /** Get events grouped by category */
-  getEventsByCategory: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
+    userType: "service",
+    access: [],
   }).output(
     z.array(
       z.object({
-        category: z.string(),
-        events: z.array(IntegrationEventInfoSchema),
-      })
-    )
-  ),
-
-  /** Get payload schema for a specific event with flattened property list for template hints */
-  getEventPayloadSchema: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(z.object({ eventId: z.string() }))
-    .output(EventPayloadSchemaOutputSchema),
-
-  // ==========================================================================
-  // DELIVERY LOGS (Admin only)
-  // ==========================================================================
-
-  /** Get delivery logs with filtering */
-  getDeliveryLogs: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(DeliveryLogQueryInputSchema)
-    .output(
-      z.object({
-        logs: z.array(DeliveryLogSchema),
-        total: z.number(),
-      })
-    ),
-
-  /** Get a single delivery log entry */
-  getDeliveryLog: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(z.object({ id: z.string() }))
-    .output(DeliveryLogSchema),
-
-  /** Retry a failed delivery */
-  retryDelivery: proc({
-    operationType: "mutation",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(z.object({ logId: z.string() }))
-    .output(z.object({ success: z.boolean(), message: z.string().optional() })),
-
-  /** Get delivery statistics for dashboard */
-  getDeliveryStats: proc({
-    operationType: "query",
-    userType: "authenticated",
-    access: [integrationAccess.manage],
-  })
-    .input(
-      z.object({
-        /** Time range in hours (default: 24) */
-        hours: z.number().min(1).max(720).default(24),
-      })
-    )
-    .output(
-      z.object({
-        total: z.number(),
-        successful: z.number(),
-        failed: z.number(),
-        retrying: z.number(),
-        pending: z.number(),
-        byEvent: z.array(
-          z.object({
-            eventType: z.string(),
-            count: z.number(),
-          })
-        ),
-        byProvider: z.array(
-          z.object({
-            providerId: z.string(),
-            count: z.number(),
-          })
-        ),
-      })
+        id: z.string(),
+        name: z.string(),
+        description: z.string().optional(),
+        providerId: z.string(),
+        providerConfig: z.record(z.string(), z.unknown()),
+        eventId: z.string(),
+        systemFilter: z.array(z.string()).optional(),
+        enabled: z.boolean(),
+      }),
     ),
+  ),
 };
 
-// Export contract type
 export type IntegrationContract = typeof integrationContract;
 
-// Export client definition for type-safe forPlugin usage
-// Use: const client = rpcApi.forPlugin(IntegrationApi);
 export const IntegrationApi = createClientDefinition(
   integrationContract,
-  pluginMetadata
+  pluginMetadata,
 );

package/src/schemas.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { PaginationInput } from "@checkstack/common";
 
 // =============================================================================
 // Webhook Subscription Schemas
@@ -95,12 +96,10 @@ export const DeliveryLogSchema = z.object({
 export type DeliveryLog = z.infer<typeof DeliveryLogSchema>;
 
 /** Input for querying delivery logs */
-export const DeliveryLogQueryInputSchema = z.object({
+export const DeliveryLogQueryInputSchema = PaginationInput.extend({
   subscriptionId: z.string().optional(),
   eventType: z.string().optional(),
   status: DeliveryStatusSchema.optional(),
-  page: z.number().min(1).default(1),
-  pageSize: z.number().min(1).max(100).default(20),
 });
 export type DeliveryLogQueryInput = z.infer<typeof DeliveryLogQueryInputSchema>;