@checkstack/integration-common 0.3.2 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,114 @@
 # @checkstack/integration-common
 
+## 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
+
+- 9016526: Add a `/rest/:pluginId/*` HTTP mount that serves every plugin's oRPC contract
+  through the REST/OpenAPI shape described by `/api/openapi.json`. Queries are
+  `GET` with query parameters, mutations are `POST` with the input as the raw
+  JSON body. The existing `/api/:pluginId/*` mount continues to serve oRPC's
+  native wire protocol unchanged, so existing clients are not affected.
+
+  The OpenAPI spec at `/api/openapi.json` now reflects the real mount: every
+  `paths` entry is prefixed with `/rest` instead of `/api`.
+
+  Also fixes a SPA-fallback bug: the backend's `/api-docs` route previously
+  returned 404 on production deployments because the static-file middleware
+  skipped any path starting with `/api`, capturing `/api-docs` along with real
+  API routes. The skip now requires a trailing slash (`/api/`, `/rest/`).
+
+  Required access rules are now visible in the API Docs UI. The OpenAPI spec
+  generator was reading a non-existent `accessRules` field on procedure
+  metadata; the real field is `access: AccessRule[]`. Each procedure's access
+  rules are now flattened to fully-qualified IDs (e.g. `catalog.system.read`)
+  and emitted under `x-orpc-meta.accessRules`, which the existing
+  `Required Access Rules` section in the docs UI already knew how to render.
+
+  The API Docs schema renderer now handles record types (zod `z.record`),
+  `$ref`s into `components.schemas`, `oneOf`/`anyOf`/`allOf`, nullable union
+  types (`type: ["string", "null"]`), and `format` qualifiers. Previously
+  record outputs like `{ statuses: object }` masked the actual value type;
+  they now render as `{ [key]: <ResolvedType> { ... } }` with the inner
+  schema expanded, capped at 12 levels with cycle detection.
+
+  **REST method conventions.** `proc()` now defaults to `GET` for queries and
+  `POST` for mutations on the `/rest` mount, using bracket-notation query
+  params (`?filter[status]=active&ids[0]=a`) for GET inputs. Existing
+  procedures were updated to follow REST semantics:
+
+  - `update*` mutations → `PATCH`
+  - `delete*` / `remove*` mutations → `DELETE`
+  - `getBulk*` queries and any query taking a large array input → `POST`
+    (because `@orpc/openapi@1.13.x` has no GET→POST URL-length fallback)
+
+  GET endpoints require an `object` input — bare scalars like
+  `.input(z.string())` are not valid on GET. `getSystemConfigurations` was
+  refactored from `.input(z.string())` to `.input(z.object({ systemId: ... }))`
+  to fit the GET shape; the only call-site update was the in-process router
+  unpacking `input.systemId` instead of passing `input` directly.
+
+  The API Docs UI now renders query parameters (path/query/header/cookie) in a
+  dedicated table for GET endpoints, and the fetch example shows them in the
+  URL with `<required>` / `<optional>` placeholders.
+
+### Patch Changes
+
+- Updated dependencies [9016526]
+  - @checkstack/common@0.10.0
+  - @checkstack/signal-common@0.2.3
+
 ## 0.3.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/integration-common",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "license": "Elastic-2.0",
   "type": "module",
   "exports": {
@@ -10,15 +10,15 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.8.0",
-    "@checkstack/signal-common": "0.2.1",
+    "@checkstack/common": "0.10.0",
+    "@checkstack/signal-common": "0.2.3",
     "@orpc/contract": "^1.13.14",
     "zod": "^4.0.0"
   },
   "devDependencies": {
     "@checkstack/tsconfig": "0.0.7",
     "typescript": "^5.7.2",
-    "@checkstack/scripts": "0.3.0"
+    "@checkstack/scripts": "0.3.2"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/rpc-contract.ts

@@ -1,7 +1,12 @@
 import { z } from "zod";
 import { integrationAccess } from "./access";
 import { pluginMetadata } from "./plugin-metadata";
-import { createClientDefinition, proc } from "@checkstack/common";
+import {
+  createClientDefinition,
+  PaginatedResult,
+  PaginationInput,
+  proc,
+} from "@checkstack/common";
 import {
   WebhookSubscriptionSchema,
   CreateSubscriptionInputSchema,
@@ -32,20 +37,13 @@ export const integrationContract = {
     access: [integrationAccess.manage],
   })
     .input(
-      z.object({
-        page: z.number().min(1).default(1),
-        pageSize: z.number().min(1).max(100).default(20),
+      PaginationInput.extend({
         providerId: z.string().optional(),
         eventType: z.string().optional(),
         enabled: z.boolean().optional(),
       })
     )
-    .output(
-      z.object({
-        subscriptions: z.array(WebhookSubscriptionSchema),
-        total: z.number(),
-      })
-    ),
+    .output(PaginatedResult(WebhookSubscriptionSchema)),
 
   /** Get a single subscription by ID */
   getSubscription: proc({
@@ -71,6 +69,7 @@ export const integrationContract = {
     userType: "authenticated",
     access: [integrationAccess.manage],
   })
+    .route({ method: "PATCH" })
     .input(UpdateSubscriptionInputSchema)
     .output(WebhookSubscriptionSchema),
 
@@ -80,6 +79,7 @@ export const integrationContract = {
     userType: "authenticated",
     access: [integrationAccess.manage],
   })
+    .route({ method: "DELETE" })
     .input(z.object({ id: z.string() }))
     .output(z.object({ success: z.boolean() })),
 
@@ -155,6 +155,7 @@ export const integrationContract = {
     userType: "authenticated",
     access: [integrationAccess.manage],
   })
+    .route({ method: "PATCH" })
     .input(UpdateConnectionInputSchema)
     .output(ProviderConnectionRedactedSchema),
 
@@ -164,6 +165,7 @@ export const integrationContract = {
     userType: "authenticated",
     access: [integrationAccess.manage],
   })
+    .route({ method: "DELETE" })
     .input(z.object({ connectionId: z.string() }))
     .output(z.object({ success: z.boolean() })),
 
@@ -230,12 +232,7 @@ export const integrationContract = {
     access: [integrationAccess.manage],
   })
     .input(DeliveryLogQueryInputSchema)
-    .output(
-      z.object({
-        logs: z.array(DeliveryLogSchema),
-        total: z.number(),
-      })
-    ),
+    .output(PaginatedResult(DeliveryLogSchema)),
 
   /** Get a single delivery log entry */
   getDeliveryLog: proc({

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>;