@checkstack/integration-backend 0.1.28 → 0.1.29

package/CHANGELOG.md

@@ -1,5 +1,88 @@
 # @checkstack/integration-backend
 
+## 0.1.29
+
+### Patch Changes
+
+- f23f3c9: Add `correlationMiddleware` to `@checkstack/backend-api` and apply it
+  to every plugin/core router so each request carries a stable
+  `x-correlation-id` (read from the inbound header, or freshly minted
+  via `crypto.randomUUID()` when absent) and an auto-injected child
+  logger bound with `{ correlationId, pluginId, userId? }`. The ID is
+  echoed back on the response header so the caller can correlate their
+  client-side trace to the server logs.
+
+  The `Logger` interface in `@checkstack/backend-api` now formally
+  documents the structured-metadata convention (`logger.info("msg",
+{ ...meta })`) alongside the long-standing varargs shape. Winston's
+  splat handling already routes both shapes through the same vararg
+  slot, so existing call sites are unaffected. A new optional
+  `Logger.child(meta)` method captures the metadata-binding contract the
+  new middleware relies on; production loggers always implement it,
+  minimal test mocks may omit it (the middleware falls back gracefully).
+
+  `RpcContext` grew two optional `Headers` bags, `requestHeaders` and
+  `responseHeaders`, populated by the outer Hono `/api/*` and `/rest/*`
+  handlers in `@checkstack/backend`. They are write-through observation
+  points for middleware; an `RpcContext` constructed without them (S2S
+  clients, tests) keeps working — the echo is a silent no-op and the ID
+  is still bound onto the child logger for server-side correlation.
+
+  The scaffolding template in `@checkstack/scripts` was updated so any
+  new plugin generated via `bun run create` wires the middleware in the
+  expected `.use(correlationMiddleware).use(autoAuthMiddleware)` order
+  out of the box.
+
+- 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`.
+
+- Updated dependencies [f23f3c9]
+- Updated dependencies [f23f3c9]
+- Updated dependencies [f23f3c9]
+  - @checkstack/common@0.11.0
+  - @checkstack/backend-api@0.17.0
+  - @checkstack/command-backend@0.1.29
+  - @checkstack/integration-common@0.5.0
+  - @checkstack/signal-common@0.2.4
+  - @checkstack/queue-api@0.3.4
+
 ## 0.1.28
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/integration-backend",
-  "version": "0.1.28",
+  "version": "0.1.29",
   "license": "Elastic-2.0",
   "type": "module",
   "main": "src/index.ts",
@@ -16,11 +16,11 @@
   },
   "dependencies": {
     "@checkstack/integration-common": "0.4.0",
-    "@checkstack/backend-api": "0.15.3",
+    "@checkstack/backend-api": "0.16.0",
     "@checkstack/signal-common": "0.2.3",
-    "@checkstack/queue-api": "0.3.2",
+    "@checkstack/queue-api": "0.3.3",
     "@checkstack/common": "0.10.0",
-    "@checkstack/command-backend": "0.1.27",
+    "@checkstack/command-backend": "0.1.28",
     "drizzle-orm": "^0.45.0",
     "zod": "^4.2.1",
     "@orpc/server": "^1.13.2"
@@ -29,7 +29,7 @@
     "@checkstack/drizzle-helper": "0.0.5",
     "@checkstack/scripts": "0.3.2",
     "@checkstack/tsconfig": "0.0.7",
-    "@checkstack/test-utils-backend": "0.1.27",
+    "@checkstack/test-utils-backend": "0.1.28",
     "@types/node": "^20.0.0",
     "drizzle-kit": "^0.31.10",
     "typescript": "^5.0.0"

package/src/router.ts

@@ -2,6 +2,7 @@ import { implement, ORPCError } from "@orpc/server";
 import type { SafeDatabase } from "@checkstack/backend-api";
 import {
   autoAuthMiddleware,
+  correlationMiddleware,
   type RpcContext,
   type Logger,
 } from "@checkstack/backend-api";
@@ -126,6 +127,7 @@ export function createIntegrationRouter(deps: RouterDeps) {
   // Create contract implementer with context type AND auto auth middleware
   const os = implement(integrationContract)
     .$context<RpcContext>()
+    .use(correlationMiddleware)
     .use(autoAuthMiddleware);
 
   return os.router({
@@ -134,8 +136,7 @@ export function createIntegrationRouter(deps: RouterDeps) {
     // =========================================================================
 
     listSubscriptions: os.listSubscriptions.handler(async ({ input }) => {
-      const { page, pageSize, providerId, eventType, enabled } = input;
-      const offset = (page - 1) * pageSize;
+      const { limit, offset, providerId, eventType, enabled } = input;
 
       // Build where conditions
       const conditions = [];
@@ -160,7 +161,7 @@ export function createIntegrationRouter(deps: RouterDeps) {
         .select()
         .from(schema.webhookSubscriptions)
         .orderBy(desc(schema.webhookSubscriptions.createdAt))
-        .limit(pageSize)
+        .limit(limit)
         .offset(offset);
 
       if (whereClause) {
@@ -175,7 +176,7 @@ export function createIntegrationRouter(deps: RouterDeps) {
         : subscriptions;
 
       return {
-        subscriptions: filtered.map((s) => ({
+        items: filtered.map((s) => ({
           ...s,
           description: s.description ?? undefined,
           systemFilter: s.systemFilter ?? undefined,
@@ -183,6 +184,8 @@ export function createIntegrationRouter(deps: RouterDeps) {
           updatedAt: s.updatedAt,
         })),
         total: Number(total),
+        limit,
+        offset,
       };
     }),
 
@@ -701,8 +704,7 @@ export function createIntegrationRouter(deps: RouterDeps) {
     // =========================================================================
 
     getDeliveryLogs: os.getDeliveryLogs.handler(async ({ input }) => {
-      const { subscriptionId, eventType, status, page, pageSize } = input;
-      const offset = (page - 1) * pageSize;
+      const { subscriptionId, eventType, status, limit, offset } = input;
 
       // Build where conditions
       const conditions = [];
@@ -738,11 +740,11 @@ export function createIntegrationRouter(deps: RouterDeps) {
         )
         .where(whereClause)
         .orderBy(desc(schema.deliveryLogs.createdAt))
-        .limit(pageSize)
+        .limit(limit)
         .offset(offset);
 
       return {
-        logs: logs.map(({ log, subscriptionName }) => ({
+        items: logs.map(({ log, subscriptionName }) => ({
           ...log,
           subscriptionName: subscriptionName ?? undefined,
           createdAt: log.createdAt,
@@ -752,6 +754,8 @@ export function createIntegrationRouter(deps: RouterDeps) {
           errorMessage: log.errorMessage ?? undefined,
         })),
         total: Number(total),
+        limit,
+        offset,
       };
     }),